gitlab-org--gitlab-foss/doc/development/README.md

9.4 KiB

comments type stage group info description
false index, dev none Development See the Technical Writers assigned to Development Guidelines: https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments-to-development-guidelines 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.

For information on using GitLab to work on your own software projects, see the GitLab user documentation.

For information on working with GitLab's API, see the API documentation.

For information on how to install, configure, update, and upgrade your own GitLab instance, see the administration documentation.

Get started

Processes

Must-reads:

Complementary reads:

Development guidelines review

When you submit a change to GitLab's development guidelines, request a review 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), for final approval of the new or changed guidelines.
  • The Technical Writer assigned to dev guidelines, to review the content for consistency and adherence to documentation guidelines.

UX and Frontend guides

Backend guides

Performance guides

Database guides

See database guidelines.

Integration guides

Testing guides

Refactoring guides

Deprecation guides

Documentation guides

Internationalization (i18n) guides

Product Analytics guides

Experiment guide

Build guides

Compliance

Go guides

Shell Scripting guides

Domain-specific guides

Other Development guides

Other GitLab Development Kit (GDK) guides