Skip to content
  • P
    Projects
  • G
    Groups
  • S
    Snippets
  • Help

Help

    • Loading...
  • Sign in

Development

Outside of docs

  • CONTRIBUTING.md main contributing guide
  • PROCESS.md contributing process
  • GitLab Development Kit (GDK) to install a development version

Styleguides

  • API styleguide Use this styleguide if you are contributing to the API.
  • Documentation styleguide Use this styleguide if you are contributing to documentation.
  • Writing documentation
    • Distinction between general documentation and technical articles
  • SQL Migration Style Guide for creating safe SQL migrations
  • Testing standards and style guidelines
  • UX guide for building GitLab with existing CSS styles and elements
  • Frontend guidelines
  • SQL guidelines for working with SQL queries
  • Sidekiq guidelines for working with Sidekiq workers
  • Gemfile guidelines

Process

  • Generate a changelog entry with bin/changelog
  • Limit conflicts with EE when developing on CE
  • Code review guidelines for reviewing code and having code reviewed.
  • Merge request performance guidelines for ensuring merge requests do not negatively impact GitLab performance

Backend howtos

  • Architecture of GitLab
  • Gotchas to avoid
  • How to dump production data to staging
  • Instrumentation
  • Performance guidelines
  • Rake tasks for development
  • Shell commands in the GitLab codebase
  • Sidekiq debugging
  • Object state models
  • Building a package for testing purposes

Databases

  • What requires downtime?
  • Adding database indexes
  • Post Deployment Migrations

i18n

  • Internationalization for GitLab

Compliance

  • Licensing for ensuring license compliance