2021-09-30 23:02:18 +05:30
---
comments: false
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."
---
# Contributor and Development Docs
Learn the processes and technical information needed for contributing to GitLab.
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/ ).
For information on using GitLab to work on your own software projects, see the
[GitLab user documentation ](../user/index.md ).
2021-11-18 22:05:49 +05:30
For information on working with the GitLab APIs, see the [API documentation ](../api/index.md ).
2021-09-30 23:02:18 +05:30
For information about how to install, configure, update, and upgrade your own
GitLab instance, see the [administration documentation ](../administration/index.md ).
## Get started
- Set up the GitLab development environment with the
[GitLab Development Kit (GDK) ](https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/README.md )
- [GitLab contributing guide ](contributing/index.md )
- [Issues workflow ](contributing/issue_workflow.md ) for more information about:
- Issue tracker guidelines.
- Triaging.
- Labels.
- Feature proposals.
- Issue weight.
- Regression issues.
- Technical or UX debt.
- [Merge requests workflow ](contributing/merge_request_workflow.md ) for more
information about:
- Merge request guidelines.
- Contribution acceptance criteria.
- Definition of done.
- Dependencies.
- [Style guides ](contributing/style_guides.md )
- [Implement design & UI elements ](contributing/design.md )
- [GitLab Architecture Overview ](architecture.md )
- [Rake tasks ](rake_tasks.md ) for development
## Processes
**Must-reads:**
- [Guide on adapting existing and introducing new components ](architecture.md#adapting-existing-and-introducing-new-components )
- [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
- [Secure coding guidelines ](secure_coding_guidelines.md )
- [Pipelines for the GitLab project ](pipelines.md )
Complementary reads:
- [GitLab core team & GitLab Inc. contribution process ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/PROCESS.md )
- [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 )
2021-10-27 15:23:28 +05:30
- [Patch release process for developers ](https://gitlab.com/gitlab-org/release/docs/blob/master/general/patch/process.md#process-for-developers )
2021-09-30 23:02:18 +05:30
- [Guidelines for implementing Enterprise Edition features ](ee_features.md )
2021-10-27 15:23:28 +05:30
- [Adding a new service component to GitLab ](adding_service_component.md )
2021-09-30 23:02:18 +05:30
- [Guidelines for changelogs ](changelog.md )
2021-10-27 15:23:28 +05:30
- [Dependencies ](dependencies.md )
- [Danger bot ](dangerbot.md )
2021-09-30 23:02:18 +05:30
- [Requesting access to ChatOps on GitLab.com ](chatops_on_gitlabcom.md#requesting-access ) (for GitLab team members)
### Development guidelines review
When you submit a change to the GitLab development guidelines, who
you ask for reviews depends on the level of change.
#### 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
If the MR proposes changes that are limited to a particular stage, group, or team,
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.
2022-06-21 17:19:12 +05:30
If the page is not assigned to a specific group, follow the
[Technical Writing review process for development guidelines ](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments-to-development-guidelines ).
2021-09-30 23:02:18 +05:30
#### 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-12-11 22:18:48 +05:30
- [Engineering Productivity ](https://about.gitlab.com/handbook/engineering/quality/engineering-productivity/ )
2021-09-30 23:02:18 +05:30
- [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.
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 .
2022-06-21 17:19:12 +05:30
1. After all approvals are 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 the page is not assigned to a specific group, follow the
[Technical Writing review process for development guidelines ](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments-to-development-guidelines ).
The Technical Writer may ask for additional approvals as previously suggested before merging the MR.
2021-09-30 23:02:18 +05:30
### Reviewer values
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/57293) in GitLab 14.1.
As a reviewer or as a reviewee, make sure to familiarize yourself with
the [reviewer values ](https://about.gitlab.com/handbook/engineering/workflow/reviewer-values/ ) we strive for at GitLab.
## UX and Frontend guides
- [GitLab Design System ](https://design.gitlab.com/ ), for building GitLab with
existing CSS styles and elements
- [Frontend guidelines ](fe_guide/index.md )
- [Emoji guide ](fe_guide/emojis.md )
## Backend guides
### General
- [Directory structure ](directory_structure.md )
2022-03-02 08:16:31 +05:30
- [GitLab EventStore ](event_store.md ) to publish/subscribe to domain events
2021-09-30 23:02:18 +05:30
- [GitLab utilities ](utilities.md )
- [Newlines style guide ](newlines_styleguide.md )
- [Logging ](logging.md )
- [Dealing with email/mailers ](emails.md )
- [Kubernetes integration guidelines ](kubernetes.md )
- [Permissions ](permissions.md )
- [Code comments ](code_comments.md )
- [Windows Development on GCP ](windows.md )
- [FIPS compliance ](fips_compliance.md )
- [`Gemfile` guidelines ](gemfile.md )
2021-11-18 22:05:49 +05:30
- [Ruby upgrade guidelines ](ruby_upgrade.md )
2021-09-30 23:02:18 +05:30
### Things to be aware of
- [Gotchas ](gotchas.md ) to avoid
- [Avoid modules with instance variables ](module_with_instance_variables.md ), if
possible
- [Guidelines for reusing abstractions ](reusing_abstractions.md )
2021-12-11 22:18:48 +05:30
- [Ruby 3 gotchas ](ruby3_gotchas.md )
2021-09-30 23:02:18 +05:30
### Rails Framework related
- [Routing ](routing.md )
- [Rails initializers ](rails_initializers.md )
- [Mass Inserting Models ](mass_insert.md )
- [Issuable-like Rails models ](issuable-like-models.md )
- [Issue types vs first-class types ](issue_types.md )
- [DeclarativePolicy framework ](policies.md )
2021-11-18 22:05:49 +05:30
- [Rails update guidelines ](rails_update.md )
2021-09-30 23:02:18 +05:30
### Debugging
- [Pry debugging ](pry_debugging.md )
- [Sidekiq debugging ](../administration/troubleshooting/sidekiq.md )
### Git specifics
- [How Git object deduplication works in GitLab ](git_object_deduplication.md )
- [Git LFS ](lfs.md )
### API
- [API style guide ](api_styleguide.md ) for contributing to the API
- [GraphQL API style guide ](api_graphql_styleguide.md ) for contributing to the
[GraphQL API ](../api/graphql/index.md )
### GitLab components and features
- [Developing against interacting components or features ](interacting_components.md )
- [Manage feature flags ](feature_flags/index.md )
- [Licensed feature availability ](licensed_feature_availability.md )
- [Accessing session data ](session.md )
- [How to dump production data to staging ](db_dump.md )
- [Geo development ](geo.md )
- [Redis guidelines ](redis.md )
2021-11-18 22:05:49 +05:30
- [Adding a new Redis instance ](redis/new_redis_instance.md )
2022-04-04 11:22:00 +05:30
- [Sidekiq guidelines ](sidekiq/index.md ) for working with Sidekiq workers
2021-09-30 23:02:18 +05:30
- [Working with Gitaly ](gitaly.md )
- [Elasticsearch integration docs ](elasticsearch.md )
2022-04-04 11:22:00 +05:30
- [Working with merge request diffs ](diffs.md )
2021-09-30 23:02:18 +05:30
- [Approval Rules ](approval_rules.md )
- [Repository mirroring ](repository_mirroring.md )
2022-05-07 20:08:51 +05:30
- [Uploads development guide ](uploads/index.md )
2021-09-30 23:02:18 +05:30
- [Auto DevOps development guide ](auto_devops.md )
- [Renaming features ](renaming_features.md )
- [Code Intelligence ](code_intelligence/index.md )
- [Feature categorization ](feature_categorization/index.md )
- [Wikis development guide ](wikis.md )
- [Image scaling guide ](image_scaling.md )
- [Cascading Settings ](cascading_settings.md )
- [Shell commands ](shell_commands.md ) in the GitLab codebase
- [Value Stream Analytics development guide ](value_stream_analytics.md )
- [Application limits ](application_limits.md )
### Import/Export
- [Working with the GitHub importer ](github_importer.md )
- [Import/Export development documentation ](import_export.md )
- [Test Import Project ](import_project.md )
- [Group migration ](bulk_import.md )
- [Export to CSV ](export_csv.md )
## Language-specific guides
### Go guides
- [Go Guidelines ](go_guide/index.md )
### Shell Scripting guides
- [Shell scripting standards and style guidelines ](shell_scripting_guide/index.md )
## Performance guides
- [Performance guidelines ](performance.md ) for writing code, benchmarks, and
certain patterns to avoid.
2021-10-27 15:23:28 +05:30
- [Caching guidelines ](caching.md ) for using caching in Rails under a GitLab environment.
2021-09-30 23:02:18 +05:30
- [Merge request performance guidelines ](merge_request_performance_guidelines.md )
for ensuring merge requests do not negatively impact GitLab performance
2022-03-02 08:16:31 +05:30
- [Profiling ](profiling.md ) a URL or tracking down N+1 queries using Bullet.
2021-09-30 23:02:18 +05:30
- [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.
## Database guides
See [database guidelines ](database/index.md ).
## Integration guides
2022-05-07 20:08:51 +05:30
- [Integrations development guide ](integrations/index.md )
2021-09-30 23:02:18 +05:30
- [Jira Connect app ](integrations/jira_connect.md )
- [Security Scanners ](integrations/secure.md )
- [Secure Partner Integration ](integrations/secure_partner_integration.md )
- [How to run Jenkins in development environment ](integrations/jenkins.md )
- [How to run local `Codesandbox` integration for Web IDE Live Preview ](integrations/codesandbox.md )
## Testing guides
- [Testing standards and style guidelines ](testing_guide/index.md )
- [Frontend testing standards and style guidelines ](testing_guide/frontend_testing.md )
## Refactoring guides
- [Refactoring guidelines ](refactoring_guide/index.md )
## Deprecation guides
- [Deprecation guidelines ](deprecation_guidelines/index.md )
## Documentation guides
- [Writing documentation ](documentation/index.md )
- [Documentation style guide ](documentation/styleguide/index.md )
- [Markdown ](../user/markdown.md )
## Internationalization (i18n) guides
- [Introduction ](i18n/index.md )
- [Externalization ](i18n/externalization.md )
- [Translation ](i18n/translation.md )
## Product Intelligence guides
- [Product Intelligence guide ](https://about.gitlab.com/handbook/product/product-intelligence-guide/ )
- [Service Ping guide ](service_ping/index.md )
- [Snowplow guide ](snowplow/index.md )
## Experiment guide
- [Introduction ](experiment_guide/index.md )
## Build guides
- [Building a package for testing purposes ](build_test_package.md )
## Compliance
- [Licensing ](licensing.md ) for ensuring license compliance
## Domain-specific guides
- [CI/CD development documentation ](cicd/index.md )
- [AppSec development documentation ](appsec/index.md )
2022-05-07 20:08:51 +05:30
## Technical Reference by Group
- [Create: Source Code BE ](backend/create_source_code_be/index.md )
2021-09-30 23:02:18 +05:30
## Other Development guides
- [Defining relations between files using projections ](projections.md )
- [Reference processing ](reference_processing.md )
- [Compatibility with multiple versions of the application running at the same time ](multi_version_compatibility.md )
- [Features inside `.gitlab/` ](features_inside_dot_gitlab.md )
- [Dashboards for stage groups ](stage_group_dashboards.md )
- [Preventing transient bugs ](transient/prevention-patterns.md )
2021-11-18 22:05:49 +05:30
- [GitLab Application SLIs ](application_slis/index.md )
2022-05-07 20:08:51 +05:30
- [Spam protection and CAPTCHA development guide ](spam_protection_and_captcha/index.md )
2021-09-30 23:02:18 +05:30
## Other GitLab Development Kit (GDK) guides
- [Run full Auto DevOps cycle in a GDK instance ](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/main/doc/howto/auto_devops.md )
- [Using GitLab Runner with the GDK ](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/main/doc/howto/runner.md )
- [Using the Web IDE terminal with the GDK ](https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/doc/howto/web_ide_terminal_gdk_setup.md )
