Reviewing merge requests

1. You are here:
2. Handbook
3. Marketing
4. Digital Experience Handbook
5. Marketing Site Handbook
6. Reviewing merge requests

On this page

• How to author good MRs
• How to give good reviews
• As the reviewer, ask yourself these questions
• Links to Helpful Guidelines
• Add the appropriate labels for triage
• Tag the appropriate people for review

This page is related to the Buyer Experience repo, Slippers repo, and Navigation repo.

For our repositories, be sure to apply one of the MR templates: For example, the marketing-site-change.md for the Buyer Experience's templates

How to author good MRs

Summary: Briefly explain what this MR is about. Be clear and accurate. Changes: List major changes. Why: Describe why these changes are necessary. Docs: Link to related docs for more context. Visuals: Add screenshots, videos, etc. to illustrate changes. Tests: Describe your testing process and results.

Remember, make this MR easy for reviewers. Be brief, precise, and thorough. Your effort here saves time for others!

How to give good reviews

• Review the description and discussions in the MR and any related issues.
• Identify what will need to be tested.
• Look at the specific code changes in the MR to see how the site could be impacted by those changes.
• Check to see if any of the updated items are shared by other locations.
• Validate expected functionality

As the reviewer, ask yourself these questions

1. Do the changes impact what they are supposed to impact as expected?
2. Do the changes impact something they are not supposed to impact?
3. Check relevant browsers.
   • Relevant browsers are those which a significant percentage of our end-users utilize.
4. Check relevant device resolutions.

Links to Helpful Guidelines

• GitLab Engineering's style guidelines.
  • The about website doesn't enforce the same code standards as GitLab engineering's product development style guides however it's recommended to follow these guidelines when possible.
  • CSS guidelines.
  • Javascript guidelines.

Add the appropriate labels for triage

In most cases, reviews will have the dex-approval::2-standard tag by default. This should be sufficient for most changes. If you are working with a sensitive change, use the following approval process as a resource: Approvel levels in the handbook

Tag the appropriate people for review

Use your best judgement in asking reviews from others. Note that key pages will need higher authorization for reviews, and their process may move slower as a result. If you are unsure who to ask a request from, start here: Tagging appropriate people for review in the handbook