187 lines
7 KiB
Markdown
187 lines
7 KiB
Markdown
---
|
|
comments: false
|
|
description: 'Learn how to contribute to GitLab.'
|
|
---
|
|
|
|
# Contributor and Development Docs
|
|
|
|
## Get started
|
|
|
|
- Set up GitLab's development environment with [GitLab Development Kit (GDK)](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/README.md)
|
|
- [GitLab contributing guide](contributing/index.md)
|
|
- [Issues workflow](contributing/issue_workflow.md) for more information on:
|
|
- 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 on:
|
|
- 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:**
|
|
|
|
- [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)
|
|
- [Guidelines for implementing Enterprise Edition features](ee_features.md)
|
|
- [Danger bot](dangerbot.md)
|
|
- [Generate a changelog entry with `bin/changelog`](changelog.md)
|
|
- [Requesting access to Chatops on GitLab.com](chatops_on_gitlabcom.md#requesting-access) (for GitLab team members)
|
|
|
|
## 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
|
|
|
|
- [GitLab utilities](utilities.md)
|
|
- [Issuable-like Rails models](issuable-like-models.md)
|
|
- [Logging](logging.md)
|
|
- [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)
|
|
- [Sidekiq guidelines](sidekiq_style_guide.md) for working with Sidekiq workers
|
|
- [Working with Gitaly](gitaly.md)
|
|
- [Manage feature flags](feature_flags/index.md)
|
|
- [Licensed feature availability](licensed_feature_availability.md)
|
|
- [Dealing with email/mailers](emails.md)
|
|
- [Shell commands](shell_commands.md) in the GitLab codebase
|
|
- [`Gemfile` guidelines](gemfile.md)
|
|
- [Pry debugging](pry_debugging.md)
|
|
- [Sidekiq debugging](sidekiq_debugging.md)
|
|
- [Accessing session data](session.md)
|
|
- [Gotchas](gotchas.md) to avoid
|
|
- [Avoid modules with instance variables](module_with_instance_variables.md) if possible
|
|
- [How to dump production data to staging](db_dump.md)
|
|
- [Working with the GitHub importer](github_importer.md)
|
|
- [Import/Export development documentation](import_export.md)
|
|
- [Test Import Project](import_project.md)
|
|
- [Elasticsearch integration docs](elasticsearch.md)
|
|
- [Working with Merge Request diffs](diffs.md)
|
|
- [Kubernetes integration guidelines](kubernetes.md)
|
|
- [Permissions](permissions.md)
|
|
- [Prometheus](prometheus.md)
|
|
- [Guidelines for reusing abstractions](reusing_abstractions.md)
|
|
- [DeclarativePolicy framework](policies.md)
|
|
- [How Git object deduplication works in GitLab](git_object_deduplication.md)
|
|
- [Geo development](geo.md)
|
|
- [Routing](routing.md)
|
|
- [Repository mirroring](repository_mirroring.md)
|
|
- [Git LFS](lfs.md)
|
|
- [Developing against interacting components or features](interacting_components.md)
|
|
- [File uploads](uploads.md)
|
|
- [Auto DevOps development guide](auto_devops.md)
|
|
- [Mass Inserting Models](mass_insert.md)
|
|
- [Value Stream Analytics development guide](value_stream_analytics.md)
|
|
- [Issue types vs first-class types](issue_types.md)
|
|
- [Application limits](application_limits.md)
|
|
- [Redis guidelines](redis.md)
|
|
- [Rails initializers](rails_initializers.md)
|
|
- [Code comments](code_comments.md)
|
|
- [Renaming features](renaming_features.md)
|
|
- [Windows Development on GCP](windows.md)
|
|
|
|
## Performance guides
|
|
|
|
- [Instrumentation](instrumentation.md) for Ruby code running in production
|
|
environments
|
|
- [Performance guidelines](performance.md) for writing code, benchmarks, and
|
|
certain patterns to avoid
|
|
- [Merge request performance guidelines](merge_request_performance_guidelines.md)
|
|
for ensuring merge requests do not negatively impact GitLab performance
|
|
- [Profiling](profiling.md) a URL, measuring performance using Sherlock, or
|
|
tracking down N+1 queries using Bullet
|
|
|
|
## Database guides
|
|
|
|
See [database guidelines](database/index.md).
|
|
|
|
## Integration guides
|
|
|
|
- [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)
|
|
|
|
## 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)
|
|
|
|
## Documentation guides
|
|
|
|
- [Writing documentation](documentation/index.md)
|
|
- [Documentation style guide](documentation/styleguide.md)
|
|
- [Markdown](../user/markdown.md)
|
|
|
|
## Internationalization (i18n) guides
|
|
|
|
- [Introduction](i18n/index.md)
|
|
- [Externalization](i18n/externalization.md)
|
|
- [Translation](i18n/translation.md)
|
|
|
|
## Telemetry guides
|
|
|
|
- [Telemetry guide](telemetry/index.md)
|
|
- [Usage Ping guide](telemetry/usage_ping.md)
|
|
- [Snowplow guide](telemetry/snowplow.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
|
|
|
|
## Go guides
|
|
|
|
- [Go Guidelines](go_guide/index.md)
|
|
|
|
## Shell Scripting guides
|
|
|
|
- [Shell scripting standards and style guidelines](shell_scripting_guide/index.md)
|
|
|
|
## Domain-specific guides
|
|
|
|
- [CI/CD development documentation](cicd/index.md)
|
|
|
|
## 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)
|
|
|
|
## 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)
|
|
- [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)
|