2017-11-01 15:56:40 +00:00
---
comments: false
2020-10-22 00:11:15 +00: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 15:56:40 +00:00
---
2019-08-12 09:52:48 +00:00
# Contributor and Development Docs
2014-04-24 17:53:18 +00:00
2020-07-23 12:09:23 +00:00
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 ).
2020-12-10 03:09:53 +00:00
For information on working with the GitLab APIs, see the [API documentation ](../api/README.md ).
2020-07-23 12:09:23 +00:00
For information on how to install, configure, update, and upgrade your own GitLab instance, see the [administration documentation ](../administration/index.md ).
2019-08-22 08:50:31 +00:00
## Get started
2016-08-04 10:45:59 +00:00
2020-12-10 03:09:53 +00:00
- Set up the GitLab development environment with [GitLab Development Kit (GDK) ](https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/master/README.md )
2018-10-11 11:57:49 +00:00
- [GitLab contributing guide ](contributing/index.md )
2020-04-30 03:09:32 +00:00
- [Issues workflow ](contributing/issue_workflow.md ) for more information on:
2020-03-02 09:07:59 +00:00
- Issue tracker guidelines.
- Triaging.
- Labels.
- Feature proposals.
- Issue weight.
- Regression issues.
- Technical or UX debt.
2020-04-30 03:09:32 +00:00
- [Merge requests workflow ](contributing/merge_request_workflow.md ) for more
2020-03-02 09:07:59 +00:00
information on:
- Merge request guidelines.
- Contribution acceptance criteria.
- Definition of done.
- Dependencies.
2020-01-28 21:08:56 +00:00
- [Style guides ](contributing/style_guides.md )
- [Implement design & UI elements ](contributing/design.md )
- [GitLab Architecture Overview ](architecture.md )
2017-10-11 05:59:34 +00:00
- [Rake tasks ](rake_tasks.md ) for development
2016-08-04 10:45:59 +00:00
2017-10-11 05:59:34 +00:00
## Processes
2020-01-28 21:08:56 +00:00
**Must-reads:**
2020-09-18 18:10:26 +00:00
- [Guide on adapting existing and introducing new components ](architecture.md#adapting-existing-and-introducing-new-components )
2019-06-17 03:54:09 +00:00
- [Code review guidelines ](code_review.md ) for reviewing code and having code reviewed
2020-01-17 18:08:41 +00:00
- [Database review guidelines ](database_review.md ) for reviewing database-related changes and complex SQL queries, and having them reviewed
2020-04-14 06:09:37 +00:00
- [Secure coding guidelines ](secure_coding_guidelines.md )
2019-09-17 14:16:34 +00:00
- [Pipelines for the GitLab project ](pipelines.md )
2020-01-28 21:08:56 +00:00
Complementary reads:
- [GitLab core team & GitLab Inc. contribution process ](https://gitlab.com/gitlab-org/gitlab/blob/master/PROCESS.md )
2018-05-08 10:55:02 +00: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 21:08:56 +00:00
- [Guidelines for implementing Enterprise Edition features ](ee_features.md )
2019-09-03 00:23:52 +00:00
- [Danger bot ](dangerbot.md )
2020-01-28 21:08:56 +00:00
- [Generate a changelog entry with `bin/changelog` ](changelog.md )
2020-03-03 09:07:54 +00:00
- [Requesting access to Chatops on GitLab.com ](chatops_on_gitlabcom.md#requesting-access ) (for GitLab team members)
2020-07-30 06:09:55 +00: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 18:09:47 +00:00
- [Adding a new service component to GitLab ](adding_service_component.md )
2017-10-11 05:59:34 +00:00
2020-10-22 00:11:15 +00:00
### Development guidelines review
2020-12-10 03:09:53 +00:00
When you submit a change to the GitLab development guidelines, request a review
2020-10-22 00:11:15 +00:00
from:
- A member of your team or group, to check for technical accuracy.
- For **significant** changes or proposals, request review from:
- Engineering managers (FE, BE, DB, Security, UX, and others), according to the subject or process you're proposing.
- The VP of Development (DRI) ([@clefelhocz1](https://gitlab.com/clefelhocz1)), for
final approval of the new or changed guidelines.
- The [Technical Writer assigned to dev guidelines ](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments-to-development-guidelines ),
to review the content for consistency and adherence to documentation guidelines.
2019-07-11 15:00:18 +00:00
## UX and Frontend guides
2016-08-04 10:45:59 +00:00
2018-11-21 15:25:15 +00:00
- [GitLab Design System ](https://design.gitlab.com/ ) for building GitLab with existing CSS styles and elements
2017-03-22 19:30:54 +00:00
- [Frontend guidelines ](fe_guide/index.md )
2017-11-14 22:29:33 +00:00
- [Emoji guide ](fe_guide/emojis.md )
2017-10-11 05:59:34 +00:00
## Backend guides
2017-12-29 06:29:53 +00:00
- [GitLab utilities ](utilities.md )
2019-10-07 06:06:10 +00:00
- [Issuable-like Rails models ](issuable-like-models.md )
2018-11-13 22:43:16 +00:00
- [Logging ](logging.md )
2020-05-20 03:08:04 +00:00
- [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 )
2016-10-21 16:13:41 +00:00
- [Sidekiq guidelines ](sidekiq_style_guide.md ) for working with Sidekiq workers
2017-10-11 05:59:34 +00:00
- [Working with Gitaly ](gitaly.md )
2020-04-15 15:09:17 +00:00
- [Manage feature flags ](feature_flags/index.md )
2019-05-05 13:57:21 +00:00
- [Licensed feature availability ](licensed_feature_availability.md )
2020-06-03 18:08:28 +00:00
- [Dealing with email/mailers ](emails.md )
2017-10-11 05:59:34 +00:00
- [Shell commands ](shell_commands.md ) in the GitLab codebase
2017-01-27 11:17:21 +00:00
- [`Gemfile` guidelines ](gemfile.md )
2018-07-20 05:31:51 +00:00
- [Pry debugging ](pry_debugging.md )
2020-12-02 21:09:44 +00:00
- [Sidekiq debugging ](../administration/troubleshooting/sidekiq.md )
2019-05-02 10:54:11 +00:00
- [Accessing session data ](session.md )
2017-10-11 05:59:34 +00:00
- [Gotchas ](gotchas.md ) to avoid
2017-11-21 15:15:24 +00:00
- [Avoid modules with instance variables ](module_with_instance_variables.md ) if possible
2017-10-11 05:59:34 +00:00
- [How to dump production data to staging ](db_dump.md )
2017-10-13 16:50:36 +00:00
- [Working with the GitHub importer ](github_importer.md )
2019-01-14 18:18:54 +00:00
- [Import/Export development documentation ](import_export.md )
2020-01-23 21:08:35 +00:00
- [Test Import Project ](import_project.md )
2019-05-05 13:57:21 +00:00
- [Elasticsearch integration docs ](elasticsearch.md )
2018-04-09 21:24:26 +00:00
- [Working with Merge Request diffs ](diffs.md )
2019-01-23 20:48:38 +00:00
- [Kubernetes integration guidelines ](kubernetes.md )
2018-09-10 10:54:52 +00:00
- [Permissions ](permissions.md )
2018-08-16 15:14:14 +00:00
- [Guidelines for reusing abstractions ](reusing_abstractions.md )
2018-10-14 22:58:29 +00:00
- [DeclarativePolicy framework ](policies.md )
2019-03-19 13:25:12 +00:00
- [How Git object deduplication works in GitLab ](git_object_deduplication.md )
2019-05-05 13:57:21 +00:00
- [Geo development ](geo.md )
2019-05-27 08:33:40 +00:00
- [Routing ](routing.md )
2019-06-18 11:11:58 +00:00
- [Repository mirroring ](repository_mirroring.md )
- [Git LFS ](lfs.md )
2019-07-19 03:04:09 +00:00
- [Developing against interacting components or features ](interacting_components.md )
2019-08-23 10:40:04 +00:00
- [File uploads ](uploads.md )
2019-10-02 06:06:28 +00:00
- [Auto DevOps development guide ](auto_devops.md )
2019-11-29 15:06:43 +00:00
- [Mass Inserting Models ](mass_insert.md )
2020-02-07 21:08:39 +00:00
- [Value Stream Analytics development guide ](value_stream_analytics.md )
2019-12-19 06:08:05 +00:00
- [Issue types vs first-class types ](issue_types.md )
2020-01-14 18:08:31 +00:00
- [Application limits ](application_limits.md )
2020-02-06 21:08:48 +00:00
- [Redis guidelines ](redis.md )
2020-03-02 12:07:57 +00:00
- [Rails initializers ](rails_initializers.md )
2020-04-02 18:08:11 +00:00
- [Code comments ](code_comments.md )
- [Renaming features ](renaming_features.md )
2020-05-19 06:08:03 +00:00
- [Windows Development on GCP ](windows.md )
2020-06-17 15:08:36 +00:00
- [Code Intelligence ](code_intelligence/index.md )
2020-06-19 12:09:07 +00:00
- [Approval Rules ](approval_rules.md )
2020-07-10 12:09:15 +00:00
- [Feature categorization ](feature_categorization/index.md )
2020-10-15 15:08:45 +00:00
- [Wikis development guide ](wikis.md )
2020-11-04 12:09:14 +00:00
- [Newlines style guide ](newlines_styleguide.md )
2020-11-16 18:09:15 +00:00
- [Image scaling guide ](image_scaling.md )
2020-12-02 15:09:37 +00:00
- [Export to CSV ](export_csv.md )
2016-08-04 10:45:59 +00:00
2017-10-11 05:59:34 +00:00
## Performance guides
2016-08-04 10:45:59 +00:00
2018-09-18 12:25:22 +00:00
- [Instrumentation ](instrumentation.md ) for Ruby code running in production
2020-11-16 18:09:15 +00:00
environments.
2018-09-18 12:25:22 +00:00
- [Performance guidelines ](performance.md ) for writing code, benchmarks, and
2020-11-16 18:09:15 +00:00
certain patterns to avoid.
2016-08-19 15:21:00 +00:00
- [Merge request performance guidelines ](merge_request_performance_guidelines.md )
for ensuring merge requests do not negatively impact GitLab performance
2018-09-18 20:17:07 +00:00
- [Profiling ](profiling.md ) a URL, measuring performance using Sherlock, or
2020-11-16 18:09:15 +00:00
tracking down N+1 queries using Bullet.
- [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 10:45:59 +00:00
2018-08-14 16:07:15 +00:00
## Database guides
2020-05-22 09:08:09 +00:00
See [database guidelines ](database/index.md ).
2019-07-15 13:12:38 +00:00
2019-05-06 00:56:13 +00:00
## Integration guides
- [Jira Connect app ](integrations/jira_connect.md )
2020-02-11 06:09:46 +00:00
- [Security Scanners ](integrations/secure.md )
2020-03-17 12:09:52 +00:00
- [Secure Partner Integration ](integrations/secure_partner_integration.md )
2020-03-26 06:08:40 +00:00
- [How to run Jenkins in development environment ](integrations/jenkins.md )
2020-12-09 21:09:43 +00:00
- [How to run local Codesandbox integration for Web IDE Live Preview ](integrations/codesandbox.md )
2019-05-06 00:56:13 +00:00
2017-10-11 14:33:57 +00: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 15:21:10 +00:00
## Refactoring guides
- [Refactoring guidelines ](refactoring_guide/index.md )
2020-07-27 09:09:42 +00:00
## Deprecation guides
- [Deprecation guidelines ](deprecation_guidelines/index.md )
2017-10-11 05:59:34 +00:00
## Documentation guides
2018-06-06 11:32:38 +00:00
- [Writing documentation ](documentation/index.md )
2020-11-12 21:09:19 +00:00
- [Documentation style guide ](documentation/styleguide/index.md )
2017-12-15 10:56:21 +00:00
- [Markdown ](../user/markdown.md )
2017-10-11 05:59:34 +00:00
## Internationalization (i18n) guides
2017-05-16 18:26:12 +00:00
2017-10-09 09:28:01 +00:00
- [Introduction ](i18n/index.md )
2017-09-26 21:15:19 +00:00
- [Externalization ](i18n/externalization.md )
- [Translation ](i18n/translation.md )
2017-05-16 18:26:12 +00:00
2020-10-08 18:08:32 +00:00
## Product Analytics guides
2019-09-18 14:02:45 +00:00
2020-11-02 21:09:10 +00:00
- [Product Analytics guide ](https://about.gitlab.com/handbook/product/product-analytics-guide/ )
2020-10-08 18:08:32 +00:00
- [Usage Ping guide ](product_analytics/usage_ping.md )
- [Snowplow guide ](product_analytics/snowplow.md )
2019-09-18 14:02:45 +00:00
2020-05-19 00:07:58 +00:00
## Experiment guide
2019-10-16 15:06:17 +00:00
- [Introduction ](experiment_guide/index.md )
2017-10-11 05:59:34 +00:00
## Build guides
- [Building a package for testing purposes ](build_test_package.md )
2016-08-04 10:45:59 +00:00
## Compliance
- [Licensing ](licensing.md ) for ensuring license compliance
2019-02-06 16:10:12 +00:00
## Go guides
- [Go Guidelines ](go_guide/index.md )
2019-05-17 19:13:55 +00:00
2019-08-05 14:47:46 +00:00
## Shell Scripting guides
- [Shell scripting standards and style guidelines ](shell_scripting_guide/index.md )
2020-01-30 15:09:15 +00:00
## Domain-specific guides
- [CI/CD development documentation ](cicd/index.md )
2019-09-25 18:06:17 +00:00
## Other Development guides
- [Defining relations between files using projections ](projections.md )
2020-11-09 03:09:03 +00:00
- [Reference processing ](reference_processing.md )
2020-05-07 09:09:51 +00:00
- [Compatibility with multiple versions of the application running at the same time ](multi_version_compatibility.md )
2020-11-09 03:09:03 +00:00
- [Features inside `.gitlab/` ](features_inside_dot_gitlab.md )
2019-09-25 18:06:17 +00:00
2019-05-17 19:13:55 +00: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 21:09:31 +00: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 )
