5.8 KiB
| stage | group | info |
|---|---|---|
| none | Development | See the Technical Writers assigned to Development Guidelines: https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-development-guidelines |
Development processes
Consult these topics for information on development processes for contributing to GitLab.
Processes
Must-reads:
- Guide on adapting existing and introducing new components
- Code review guidelines for reviewing code and having code reviewed
- Database review guidelines for reviewing database-related changes and complex SQL queries, and having them reviewed
- Secure coding guidelines
- Pipelines for the GitLab project
Complementary reads:
- Contribute to GitLab
- Security process for developers
- Patch release process for developers
- Guidelines for implementing Enterprise Edition features
- Adding a new service component to GitLab
- Guidelines for changelogs
- Dependencies
- Danger bot
- Requesting access to ChatOps on GitLab.com (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 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 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.
Broader changes
Some changes affect more than one group. For example:
- Changes to code review guidelines.
- Changes to commit message guidelines.
- Changes to guidelines in feature flags in development of GitLab.
- Changes to feature flags documentation guidelines.
In these cases, use the following workflow:
-
Request a peer review from a member of your team.
-
Request a review and approval of an Engineering Manager (EM) or Staff Engineer who's responsible for the area in question:
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.
-
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.
-
After all approvals are complete, assign the MR to the Technical Writer associated with the stage and group 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. The Technical Writer may ask for additional approvals as previously suggested before merging the MR.
Reviewer values
Introduced in GitLab 14.1.
As a reviewer or as a reviewee, make sure to familiarize yourself with the reviewer values we strive for at GitLab.