2017-11-01 11:56:40 -04:00
---
comments: false
2020-10-21 20:11:15 -04:00
type: index, dev
stage: none
group: Development
info: "See the Technical Writers assigned to Development Guidelines: https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments-to-development-guidelines"
description: "Development Guidelines: learn how to contribute to GitLab."
2017-11-01 11:56:40 -04:00
---
2019-08-12 05:52:48 -04:00
# Contributor and Development Docs
2014-04-24 13:53:18 -04:00
2020-07-23 08:09:23 -04:00
Learn the processes and technical information needed for contributing to GitLab.
2020-12-14 13:09:48 -05:00
This content is intended for members of the GitLab Team as well as community
contributors. Content specific to the GitLab Team should instead be included in
the [Handbook ](https://about.gitlab.com/handbook/ ).
2020-07-23 08:09:23 -04:00
2020-12-14 13:09:48 -05:00
For information on using GitLab to work on your own software projects, see the
[GitLab user documentation ](../user/index.md ).
2020-07-23 08:09:23 -04:00
2020-12-09 22:09:53 -05:00
For information on working with the GitLab APIs, see the [API documentation ](../api/README.md ).
2020-07-23 08:09:23 -04:00
2020-12-14 13:09:48 -05:00
For information about how to install, configure, update, and upgrade your own
GitLab instance, see the [administration documentation ](../administration/index.md ).
2020-07-23 08:09:23 -04:00
2019-08-22 04:50:31 -04:00
## Get started
2016-08-04 06:45:59 -04:00
2020-12-14 13:09:48 -05:00
- Set up the GitLab development environment with the
[GitLab Development Kit (GDK) ](https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/master/README.md )
2018-10-11 07:57:49 -04:00
- [GitLab contributing guide ](contributing/index.md )
2020-12-14 13:09:48 -05:00
- [Issues workflow ](contributing/issue_workflow.md ) for more information about:
2020-03-02 04:07:59 -05:00
- Issue tracker guidelines.
- Triaging.
- Labels.
- Feature proposals.
- Issue weight.
- Regression issues.
- Technical or UX debt.
2020-04-29 23:09:32 -04:00
- [Merge requests workflow ](contributing/merge_request_workflow.md ) for more
2020-12-14 13:09:48 -05:00
information about:
2020-03-02 04:07:59 -05:00
- Merge request guidelines.
- Contribution acceptance criteria.
- Definition of done.
- Dependencies.
2020-01-28 16:08:56 -05:00
- [Style guides ](contributing/style_guides.md )
- [Implement design & UI elements ](contributing/design.md )
- [GitLab Architecture Overview ](architecture.md )
2017-10-11 01:59:34 -04:00
- [Rake tasks ](rake_tasks.md ) for development
2016-08-04 06:45:59 -04:00
2017-10-11 01:59:34 -04:00
## Processes
2020-01-28 16:08:56 -05:00
**Must-reads:**
2020-09-18 14:10:26 -04:00
- [Guide on adapting existing and introducing new components ](architecture.md#adapting-existing-and-introducing-new-components )
2020-12-14 13:09:48 -05:00
- [Code review guidelines ](code_review.md ) for reviewing code and having code
reviewed
- [Database review guidelines ](database_review.md ) for reviewing
database-related changes and complex SQL queries, and having them reviewed
2020-04-14 02:09:37 -04:00
- [Secure coding guidelines ](secure_coding_guidelines.md )
2019-09-17 10:16:34 -04:00
- [Pipelines for the GitLab project ](pipelines.md )
2020-01-28 16:08:56 -05:00
Complementary reads:
- [GitLab core team & GitLab Inc. contribution process ](https://gitlab.com/gitlab-org/gitlab/blob/master/PROCESS.md )
2018-05-08 06:55:02 -04:00
- [Security process for developers ](https://gitlab.com/gitlab-org/release/docs/blob/master/general/security/developer.md#security-releases-critical-non-critical-as-a-developer )
2020-01-28 16:08:56 -05:00
- [Guidelines for implementing Enterprise Edition features ](ee_features.md )
2019-09-02 20:23:52 -04:00
- [Danger bot ](dangerbot.md )
2020-01-28 16:08:56 -05:00
- [Generate a changelog entry with `bin/changelog` ](changelog.md )
2020-12-16 19:09:53 -05:00
- [Requesting access to ChatOps on GitLab.com ](chatops_on_gitlabcom.md#requesting-access ) (for GitLab team members)
2020-07-30 02:09:55 -04:00
- [Patch release process for developers ](https://gitlab.com/gitlab-org/release/docs/blob/master/general/patch/process.md#process-for-developers )
2020-09-16 14:09:47 -04:00
- [Adding a new service component to GitLab ](adding_service_component.md )
2017-10-11 01:59:34 -04:00
2020-10-21 20:11:15 -04:00
### Development guidelines review
2020-12-16 19:09:53 -05:00
When you submit a change to the GitLab development guidelines, who
2020-12-16 13:10:10 -05:00
you ask for reviews depends on the level of change.
2020-10-21 20:11:15 -04:00
2020-12-14 13:09:48 -05:00
#### Wording, style, or link changes
Not all changes require extensive review. For example, MRs that don't change the
content's meaning or function can be reviewed, approved, and merged by any
maintainer or Technical Writer. These can include:
- Typo fixes.
- Clarifying links, such as to external programming language documentation.
- Changes to comply with the [Documentation Style Guide ](documentation/index.md )
that don't change the intent of the documentation page.
#### Specific changes
2020-12-16 13:10:10 -05:00
If the MR proposes changes that are limited to a particular stage, group, or team,
2020-12-14 13:09:48 -05:00
request a review and approval from an experienced GitLab Team Member in that
group. For example, if you're documenting a new internal API used exclusively by
a given group, request an engineering review from one of the group's members.
After the engineering review is complete, assign the MR to the
[Technical Writer associated with the stage and group ](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments )
in the modified documentation page's metadata.
If you have questions or need further input, request a review from the
Technical Writer assigned to the [Development Guidelines ](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments-to-development-guidelines ).
#### Broader changes
Some changes affect more than one group. For example:
- Changes to [code review guidelines ](code_review.md ).
- Changes to [commit message guidelines ](contributing/merge_request_workflow.md#commit-messages-guidelines ).
- Changes to guidelines in [feature flags in development of GitLab ](feature_flags/ ).
- Changes to [feature flags documentation guidelines ](documentation/feature_flags.md ).
In these cases, use the following workflow:
1. Request a peer review from a member of your team.
1. Request a review and approval of an Engineering Manager (EM)
or Staff Engineer who's responsible for the area in question:
- [Frontend ](https://about.gitlab.com/handbook/engineering/frontend/ )
- [Backend ](https://about.gitlab.com/handbook/engineering/ )
- [Database ](https://about.gitlab.com/handbook/engineering/development/database/ )
- [User Experience (UX) ](https://about.gitlab.com/handbook/engineering/ux/ )
- [Security ](https://about.gitlab.com/handbook/engineering/security/ )
- [Quality ](https://about.gitlab.com/handbook/engineering/quality/ )
2021-02-10 13:09:02 -05:00
- [Engineering Productivity ](https://about.gitlab.com/handbook/engineering/quality/engineering-productivity-team/ )
2020-12-14 13:09:48 -05:00
- [Infrastructure ](https://about.gitlab.com/handbook/engineering/infrastructure/ )
- [Technical Writing ](https://about.gitlab.com/handbook/engineering/ux/technical-writing/ )
You can skip this step for MRs authored by EMs or Staff Engineers responsible
for their area.
If there are several affected groups, you may need approvals at the
EM/Staff Engineer level from each affected area.
1. After completing the reviews, consult with the EM/Staff Engineer
author / approver of the MR.
2020-12-16 19:09:53 -05:00
2020-12-14 13:09:48 -05:00
If this is a significant change across multiple areas, request final review
and approval from the VP of Development, the DRI for Development Guidelines,
@clefelhocz1 .
1. After all approvals are complete, assign the merge request to the
Technical Writer for [Development Guidelines ](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments-to-development-guidelines )
for final content review and merge. The Technical Writer may ask for
additional approvals as previously suggested before merging the MR.
2020-10-21 20:11:15 -04:00
2019-07-11 11:00:18 -04:00
## UX and Frontend guides
2016-08-04 06:45:59 -04:00
2020-12-14 13:09:48 -05:00
- [GitLab Design System ](https://design.gitlab.com/ ), for building GitLab with
existing CSS styles and elements
2017-03-22 15:30:54 -04:00
- [Frontend guidelines ](fe_guide/index.md )
2017-11-14 17:29:33 -05:00
- [Emoji guide ](fe_guide/emojis.md )
2017-10-11 01:59:34 -04:00
## Backend guides
2021-01-20 19:11:07 -05:00
- [Directory structure ](directory_structure.md )
2017-12-29 01:29:53 -05:00
- [GitLab utilities ](utilities.md )
2019-10-07 02:06:10 -04:00
- [Issuable-like Rails models ](issuable-like-models.md )
2018-11-13 17:43:16 -05:00
- [Logging ](logging.md )
2020-05-19 23:08:04 -04:00
- [API style guide ](api_styleguide.md ) for contributing to the API
2020-12-14 13:09:48 -05:00
- [GraphQL API style guide ](api_graphql_styleguide.md ) for contributing to the
[GraphQL API ](../api/graphql/index.md )
2016-10-21 12:13:41 -04:00
- [Sidekiq guidelines ](sidekiq_style_guide.md ) for working with Sidekiq workers
2017-10-11 01:59:34 -04:00
- [Working with Gitaly ](gitaly.md )
2020-04-15 11:09:17 -04:00
- [Manage feature flags ](feature_flags/index.md )
2019-05-05 09:57:21 -04:00
- [Licensed feature availability ](licensed_feature_availability.md )
2020-06-03 14:08:28 -04:00
- [Dealing with email/mailers ](emails.md )
2017-10-11 01:59:34 -04:00
- [Shell commands ](shell_commands.md ) in the GitLab codebase
2017-01-27 06:17:21 -05:00
- [`Gemfile` guidelines ](gemfile.md )
2018-07-20 01:31:51 -04:00
- [Pry debugging ](pry_debugging.md )
2020-12-02 16:09:44 -05:00
- [Sidekiq debugging ](../administration/troubleshooting/sidekiq.md )
2019-05-02 06:54:11 -04:00
- [Accessing session data ](session.md )
2017-10-11 01:59:34 -04:00
- [Gotchas ](gotchas.md ) to avoid
2020-12-14 13:09:48 -05:00
- [Avoid modules with instance variables ](module_with_instance_variables.md ), if
possible
2017-10-11 01:59:34 -04:00
- [How to dump production data to staging ](db_dump.md )
2017-10-13 12:50:36 -04:00
- [Working with the GitHub importer ](github_importer.md )
2019-01-14 13:18:54 -05:00
- [Import/Export development documentation ](import_export.md )
2020-01-23 16:08:35 -05:00
- [Test Import Project ](import_project.md )
2019-05-05 09:57:21 -04:00
- [Elasticsearch integration docs ](elasticsearch.md )
2018-04-09 17:24:26 -04:00
- [Working with Merge Request diffs ](diffs.md )
2019-01-23 15:48:38 -05:00
- [Kubernetes integration guidelines ](kubernetes.md )
2018-09-10 06:54:52 -04:00
- [Permissions ](permissions.md )
2018-08-16 11:14:14 -04:00
- [Guidelines for reusing abstractions ](reusing_abstractions.md )
2018-10-14 18:58:29 -04:00
- [DeclarativePolicy framework ](policies.md )
2019-03-19 09:25:12 -04:00
- [How Git object deduplication works in GitLab ](git_object_deduplication.md )
2019-05-05 09:57:21 -04:00
- [Geo development ](geo.md )
2019-05-27 04:33:40 -04:00
- [Routing ](routing.md )
2019-06-18 07:11:58 -04:00
- [Repository mirroring ](repository_mirroring.md )
- [Git LFS ](lfs.md )
2019-07-18 23:04:09 -04:00
- [Developing against interacting components or features ](interacting_components.md )
2019-08-23 06:40:04 -04:00
- [File uploads ](uploads.md )
2019-10-02 02:06:28 -04:00
- [Auto DevOps development guide ](auto_devops.md )
2019-11-29 10:06:43 -05:00
- [Mass Inserting Models ](mass_insert.md )
2020-02-07 16:08:39 -05:00
- [Value Stream Analytics development guide ](value_stream_analytics.md )
2019-12-19 01:08:05 -05:00
- [Issue types vs first-class types ](issue_types.md )
2020-01-14 13:08:31 -05:00
- [Application limits ](application_limits.md )
2020-02-06 16:08:48 -05:00
- [Redis guidelines ](redis.md )
2020-03-02 07:07:57 -05:00
- [Rails initializers ](rails_initializers.md )
2020-04-02 14:08:11 -04:00
- [Code comments ](code_comments.md )
- [Renaming features ](renaming_features.md )
2020-05-19 02:08:03 -04:00
- [Windows Development on GCP ](windows.md )
2020-06-17 11:08:36 -04:00
- [Code Intelligence ](code_intelligence/index.md )
2020-06-19 08:09:07 -04:00
- [Approval Rules ](approval_rules.md )
2020-07-10 08:09:15 -04:00
- [Feature categorization ](feature_categorization/index.md )
2020-10-15 11:08:45 -04:00
- [Wikis development guide ](wikis.md )
2020-11-04 07:09:14 -05:00
- [Newlines style guide ](newlines_styleguide.md )
2020-11-16 13:09:15 -05:00
- [Image scaling guide ](image_scaling.md )
2020-12-02 10:09:37 -05:00
- [Export to CSV ](export_csv.md )
2016-08-04 06:45:59 -04:00
2017-10-11 01:59:34 -04:00
## Performance guides
2016-08-04 06:45:59 -04:00
2018-09-18 08:25:22 -04:00
- [Instrumentation ](instrumentation.md ) for Ruby code running in production
2020-11-16 13:09:15 -05:00
environments.
2018-09-18 08:25:22 -04:00
- [Performance guidelines ](performance.md ) for writing code, benchmarks, and
2020-11-16 13:09:15 -05:00
certain patterns to avoid.
2016-08-19 11:21:00 -04:00
- [Merge request performance guidelines ](merge_request_performance_guidelines.md )
for ensuring merge requests do not negatively impact GitLab performance
2018-09-18 16:17:07 -04:00
- [Profiling ](profiling.md ) a URL, measuring performance using Sherlock, or
2020-11-16 13:09:15 -05:00
tracking down N+1 queries using Bullet.
2020-12-14 13:09:48 -05:00
- [Cached queries guidelines ](cached_queries.md ), for tracking down N+1 queries
masked by query caching, memory profiling and why should we avoid cached
queries.
2016-08-04 06:45:59 -04:00
2018-08-14 12:07:15 -04:00
## Database guides
2020-05-22 05:08:09 -04:00
See [database guidelines ](database/index.md ).
2019-07-15 09:12:38 -04:00
2019-05-05 20:56:13 -04:00
## Integration guides
- [Jira Connect app ](integrations/jira_connect.md )
2020-02-11 01:09:46 -05:00
- [Security Scanners ](integrations/secure.md )
2020-03-17 08:09:52 -04:00
- [Secure Partner Integration ](integrations/secure_partner_integration.md )
2020-03-26 02:08:40 -04:00
- [How to run Jenkins in development environment ](integrations/jenkins.md )
2021-01-22 19:08:46 -05:00
- [How to run local `Codesandbox` integration for Web IDE Live Preview ](integrations/codesandbox.md )
2019-05-05 20:56:13 -04:00
2017-10-11 10:33:57 -04:00
## Testing guides
- [Testing standards and style guidelines ](testing_guide/index.md )
- [Frontend testing standards and style guidelines ](testing_guide/frontend_testing.md )
2020-04-21 11:21:10 -04:00
## Refactoring guides
- [Refactoring guidelines ](refactoring_guide/index.md )
2020-07-27 05:09:42 -04:00
## Deprecation guides
- [Deprecation guidelines ](deprecation_guidelines/index.md )
2017-10-11 01:59:34 -04:00
## Documentation guides
2018-06-06 07:32:38 -04:00
- [Writing documentation ](documentation/index.md )
2020-11-12 16:09:19 -05:00
- [Documentation style guide ](documentation/styleguide/index.md )
2017-12-15 05:56:21 -05:00
- [Markdown ](../user/markdown.md )
2017-10-11 01:59:34 -04:00
## Internationalization (i18n) guides
2017-05-16 14:26:12 -04:00
2017-10-09 05:28:01 -04:00
- [Introduction ](i18n/index.md )
2017-09-26 17:15:19 -04:00
- [Externalization ](i18n/externalization.md )
- [Translation ](i18n/translation.md )
2017-05-16 14:26:12 -04:00
2021-01-12 22:10:20 -05:00
## Product Intelligence guides
2019-09-18 10:02:45 -04:00
2021-01-12 22:10:20 -05:00
- [Product Intelligence guide ](https://about.gitlab.com/handbook/product/product-intelligence-guide/ )
2021-03-02 04:10:43 -05:00
- [Usage Ping guide ](usage_ping/index.md )
2021-01-12 22:10:20 -05:00
- [Snowplow guide ](snowplow.md )
2019-09-18 10:02:45 -04:00
2020-05-18 20:07:58 -04:00
## Experiment guide
2019-10-16 11:06:17 -04:00
- [Introduction ](experiment_guide/index.md )
2017-10-11 01:59:34 -04:00
## Build guides
- [Building a package for testing purposes ](build_test_package.md )
2016-08-04 06:45:59 -04:00
## Compliance
- [Licensing ](licensing.md ) for ensuring license compliance
2019-02-06 11:10:12 -05:00
## Go guides
- [Go Guidelines ](go_guide/index.md )
2019-05-17 15:13:55 -04:00
2019-08-05 10:47:46 -04:00
## Shell Scripting guides
- [Shell scripting standards and style guidelines ](shell_scripting_guide/index.md )
2020-01-30 10:09:15 -05:00
## Domain-specific guides
- [CI/CD development documentation ](cicd/index.md )
2021-02-24 16:11:16 -05:00
- [AppSec development documentation ](appsec/index.md )
2020-01-30 10:09:15 -05:00
2019-09-25 14:06:17 -04:00
## Other Development guides
- [Defining relations between files using projections ](projections.md )
2020-11-08 22:09:03 -05:00
- [Reference processing ](reference_processing.md )
2020-05-07 05:09:51 -04:00
- [Compatibility with multiple versions of the application running at the same time ](multi_version_compatibility.md )
2020-11-08 22:09:03 -05:00
- [Features inside `.gitlab/` ](features_inside_dot_gitlab.md )
2020-12-30 10:10:28 -05:00
- [Dashboards for stage groups ](stage_group_dashboards.md )
2021-02-09 19:09:33 -05:00
- [Preventing transient bugs ](transient/prevention-patterns.md )
2019-09-25 14:06:17 -04:00
2019-05-17 15:13:55 -04:00
## Other GitLab Development Kit (GDK) guides
- [Run full Auto DevOps cycle in a GDK instance ](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/auto_devops.md )
2020-04-29 17:09:31 -04:00
- [Using GitLab Runner with the GDK ](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/runner.md )
- [Using the Web IDE terminal with the GDK ](https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/master/doc/howto/web_ide_terminal_gdk_setup.md )
