kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/doc/development/contributing/merge_request_workflow.md

20 KiB
Raw Blame History

type stage group info
reference, dev none Development To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments

Merge requests workflow

We welcome merge requests from everyone, with fixes and improvements to GitLab code, tests, and documentation. The issues that are specifically suitable for community contributions have the Seeking community contributions label, but you are free to contribute to any issue you want.

If an issue is marked for the current milestone at any time, even when you are working on it, a GitLab Inc. team member may take over the merge request in order to ensure the work is finished before the release date.

If you want to add a new feature that is not labeled, it is best to first create an issue (if there isn't one already) and leave a comment asking for it to be labeled as Seeking community contributions. See the feature proposals section.

Merge requests should be submitted to the appropriate project at GitLab.com, for example GitLab, GitLab Runner, or Omnibus GitLab.

If you are new to GitLab development (or web development in general), see the how to contribute section to get started with some potentially easy issues.

To start developing GitLab, download the GitLab Development Kit and see the Development section for the required guidelines.

Merge request guidelines

If you find an issue, please submit a merge request with a fix or improvement, if you can, and include tests. If you don't know how to fix the issue but can write a test that exposes the issue, we will accept that as well. In general, bug fixes that include a regression test are merged quickly, while new features without proper tests might be slower to receive feedback. The workflow to make a merge request is as follows:

  1. Fork the project into your personal namespace (or group) on GitLab.com.

  2. Create a feature branch in your fork (don't work off your default branch).

  3. Write tests and code.

  4. Ensure a changelog is created.

  5. If you are writing documentation, make sure to follow the documentation guidelines.

  6. Follow the commit messages guidelines.

  7. If you have multiple commits, combine them into a few logically organized commits by squashing them, but do not change the commit history if you're working on shared branches though.

  8. Push the commits to your working branch in your fork.

  9. Submit a merge request (MR) to the main branch in the main GitLab project.

    1. Your merge request needs at least 1 approval, but depending on your changes you might need additional approvals. Refer to the Approval guidelines.
    2. You don't have to select any specific approvers, but you can if you really want specific people to approve your merge request.

  10. The MR title should describe the change you want to make.

  11. The MR description should give a reason for your change.

    1. If you are contributing code, fill in the description according to the default template already provided in the "Description" field.
    2. If you are contributing documentation, choose Documentation from the "Choose a template" menu and fill in the description according to the template.
    3. Use the syntax Solves #XXX, Closes #XXX, or Refs #XXX to mention the issues your merge request addresses. Referenced issues do not close automatically. You must close them manually once the merge request is merged.
    4. The MR must include Before and After screenshots if UI changes are made.
    5. Include any steps or setup required to ensure reviewers can view the changes you've made (for example, include any information about feature flags).

  12. If you're allowed to, set a relevant milestone and labels. MR labels should generally match the corresponding issue (if there is one). The group label should reflect the group that executed or coached the work, not necessarily the group that owns the feature.

  13. UI changes should use available components from the GitLab Design System, Pajamas.

  14. If the MR changes CSS classes, please include the list of affected pages, which can be found by running grep css-class ./app -R.

  15. If your MR touches code that executes shell commands, reads or opens files, or handles paths to files on disk, make sure it adheres to the shell command guidelines

  16. Code changes should include observability instrumentation.

  17. If your code needs to handle file storage, see the uploads documentation.

  18. If your merge request adds one or more migrations, make sure to execute all migrations on a fresh database before the MR is reviewed. If the review leads to large changes in the MR, execute the migrations again once the review is complete.

  19. Write tests for more complex migrations.

  20. If your merge request adds new validations to existing models, to make sure the data processing is backwards compatible:

    • Ask in the #database Slack channel for assistance to execute the database query that checks the existing rows to ensure existing rows aren't impacted by the change.
    • Add the necessary validation with a feature flag to be gradually rolled out following the rollout steps.

    If this merge request is urgent, the code owners should make the final call on whether reviewing existing rows should be included as an immediate follow-up task to the merge request.

    NOTE: There isn't a way to know anything about our customers' data on their self-managed instances, so keep that in mind for any data implications with your merge request.

  21. Merge requests must adhere to the merge request performance guidelines.

  22. For tests that use Capybara, read how to write reliable, asynchronous integration tests.

  23. If your merge request introduces changes that require additional steps when installing GitLab from source, add them to doc/install/installation.md in the same merge request.

  24. If your merge request introduces changes that require additional steps when upgrading GitLab from source, add them to doc/update/upgrading_from_source.md in the same merge request. If these instructions are specific to a version, add them to the "Version specific upgrading instructions" section.

  25. Read and adhere to The responsibility of the merge request author.

  26. Read and follow Having your merge request reviewed.

If you would like quick feedback on your merge request feel free to mention someone from the core team or one of the merge request coaches. When having your code reviewed and when reviewing merge requests, please keep the code review guidelines in mind. And if your code also makes changes to the database, or does expensive queries, check the database review guidelines.

Keep it simple

Live by smaller iterations. Please keep the amount of changes in a single MR as small as possible. If you want to contribute a large feature, think very carefully about what the minimum viable change is. Can you split the functionality into two smaller MRs? Can you submit only the backend/API code? Can you start with a very simple UI? Can you do just a part of the refactor?

Small MRs which are more easily reviewed, lead to higher code quality which is more important to GitLab than having a minimal commit log. The smaller an MR is, the more likely it will be merged quickly. After that you can send more MRs to enhance and expand the feature. The How to get faster PR reviews document from the Kubernetes team also has some great points regarding this.

Commit messages guidelines

Commit messages should follow the guidelines below, for reasons explained by Chris Beams in How to Write a Git Commit Message:

  • The commit subject and body must be separated by a blank line.
  • The commit subject must start with a capital letter.
  • The commit subject must not be longer than 72 characters.
  • The commit subject must not end with a period.
  • The commit body must not contain more than 72 characters per line.
  • The commit subject or body must not contain Emojis.
  • Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body.
  • Use issues and merge requests' full URLs instead of short references, as they are displayed as plain text outside of GitLab.
  • The merge request should not contain more than 10 commit messages.
  • The commit subject should contain at least 3 words.

Important notes:

  • If the guidelines are not met, the MR may not pass the Danger checks.
  • Consider enabling Squash and merge if your merge request includes "Applied suggestion to X files" commits, so that Danger can ignore those.
  • The prefixes in the form of [prefix] and prefix: are allowed (they can be all lowercase, as long as the message itself is capitalized). For instance, danger: Improve Danger behavior and [API] Improve the labels endpoint are valid commit messages.

Why these standards matter

  1. Consistent commit messages that follow these guidelines make the history more readable.
  2. Concise standard commit messages helps to identify breaking changes for a deployment or ~"master:broken" quicker when reviewing commits between two points in time.

Commit message template

Example commit message template that can be used on your machine that embodies the above (guide for how to apply template):

# (If applied, this commit will...) <subject>        (Max 72 characters)
# |<----          Using a Maximum Of 72 Characters                ---->|


# Explain why this change is being made
# |<----   Try To Limit Each Line to a Maximum Of 72 Characters   ---->|

# Provide links or keys to any relevant tickets, articles or other resources
# Use issues and merge requests' full URLs instead of short references,
# as they are displayed as plain text outside of GitLab

# --- COMMIT END ---
# --------------------
# Remember to
#    Capitalize the subject line
#    Use the imperative mood in the subject line
#    Do not end the subject line with a period
#    Subject must contain at least 3 words
#    Separate subject from body with a blank line
#    Commits that change 30 or more lines across at least 3 files should
#    describe these changes in the commit body
#    Do not use Emojis
#    Use the body to explain what and why vs. how
#    Can use multiple lines with "-" for bullet points in body
#    For more information: https://cbea.ms/git-commit/
# --------------------

Contribution acceptance criteria

To make sure that your merge request can be approved, please ensure that it meets the contribution acceptance criteria below:

  1. The change is as small as possible.
  2. Include proper tests and make all tests pass (unless it contains a test exposing a bug in existing code). Every new class should have corresponding unit tests, even if the class is exercised at a higher level, such as a feature test.
    • If a failing CI build seems to be unrelated to your contribution, you can try restarting the failing CI job, rebasing from main to bring in updates that may resolve the failure, or if it has not been fixed yet, ask a developer to help you fix the test.
  3. The MR initially contains a few logically organized commits.
  4. The changes can merge without problems. If not, you should rebase if you're the only one working on your feature branch, otherwise merge main.
  5. Only one specific issue is fixed or one specific feature is implemented. Do not combine things; send separate merge requests for each issue or feature.
  6. Migrations should do only one thing (for example, create a table, move data to a new table, or remove an old table) to aid retrying on failure.
  7. Contains functionality that other users will benefit from.
  8. Doesn't add configuration options or settings options since they complicate making and testing future changes.
  9. Changes do not degrade performance:
    • Avoid repeated polling of endpoints that require a significant amount of overhead.
    • Check for N+1 queries via the SQL log or QueryRecorder.
    • Avoid repeated access of the file system.
    • Use polling with ETag caching if needed to support real-time features.
  10. If the merge request adds any new libraries (like gems or JavaScript libraries), they should conform to our Licensing guidelines. See those instructions for help if the "license-finder" test fails with a Dependencies that need approval error. Also, make the reviewer aware of the new library and explain why you need it.
  11. The merge request meets the GitLab definition of done, below.

Definition of done

If you contribute to GitLab, please know that changes involve more than just code. We use the following definition of done. To reach the definition of done, the merge request must create no regressions and meet all these criteria:

  • Verified as working in production on GitLab.com.
  • Verified as working for self-managed instances.

If a regression occurs, we prefer you revert the change. We break the definition of done into two phases: MR Merge and Production use. Your contribution is incomplete until you have made sure it meets all of these requirements.

MR Merge

  1. Clear description explaining the relevancy of the contribution.
  2. Working and clean code that is commented where needed.
  3. Unit, integration, and system tests that all pass on the CI server.
  4. Peer member testing is optional but recommended when the risk of a change is high. This includes when the changes are far-reaching or are for components critical for security.
  5. Regressions and bugs are covered with tests that reduce the risk of the issue happening again.
  6. Code affected by a feature flag is covered by automated tests with the feature flag enabled and disabled, or both states are tested as part of peer member testing or as part of the rollout plan.
  7. Performance guidelines have been followed.
  8. Secure coding guidelines have been followed.
  9. Application and rate limit guidelines have been followed.
  10. Documented in the /doc directory.
  11. Changelog entry added, if necessary.
  12. Reviewed by relevant reviewers, and all concerns are addressed for Availability, Regressions, and Security. Documentation reviews should take place as soon as possible, but they should not block a merge request.
  13. The MR acceptance checklist has been checked as confirmed in the MR.
  14. Create an issue in the infrastructure issue tracker to inform the Infrastructure department when your contribution is changing default settings or introduces a new setting, if relevant.
  15. Black-box tests/end-to-end tests added if required. Please contact the quality team with any questions.
  16. The change is tested in a review app where possible and if appropriate.
  17. The new feature does not degrade the user experience of the product.
  18. The change is evaluated to limit the impact of far-reaching work.
  19. An agreed-upon rollout plan.
  20. Merged by a project maintainer.

Production use

  1. Confirmed to be working in staging before implementing the change in production, where possible.
  2. Confirmed to be working in the production with no new Sentry errors after the contribution is deployed.
  3. Confirmed that the rollout plan has been completed.
  4. If there is a performance risk in the change, I have analyzed the performance of the system before and after the change.
  5. If the merge request uses feature flags, per-project or per-group enablement, and a staged rollout:
    • Confirmed to be working on GitLab projects.
    • Confirmed to be working at each stage for all projects added.
  6. Added to the release post, if relevant.
  7. Added to the website, if relevant.

Contributions do not require approval from the Product team.

Dependencies

If you add a dependency in GitLab (such as an operating system package) please consider updating the following, and note the applicability of each in your merge request:

  1. Note the addition in the release blog post (create one if it doesn't exist yet).
  2. The upgrade guide.
  3. The GitLab Installation Guide.
  4. The GitLab Development Kit.
  5. The CI environment preparation.
  6. The Omnibus package creator.
  7. The Cloud Native GitLab Dockerfiles

Incremental improvements

We allow engineering time to fix small problems (with or without an issue) that are incremental improvements, such as:

  1. Unprioritized bug fixes (for example, Banner alerting of project move is showing up everywhere)
  2. Documentation improvements
  3. Rubocop or Code Quality improvements

Tag a merge request with ~"Stuff that should Just Work" to track work in this area.