Skip to content

Reviewing a Pull Request

When a contributor submits a pull request with doc updates, someone needs to review and approve the proposed changes.

Instructions

Here's how to review and approve a pull request.

  1. Open a web browser and access the doc repo in GitHub.
  2. Open the Pull requests tab.
  3. Open the pull request with the changes you want to review.
  4. Expand the individual changes added to the pull request.

  5. Open the staging site that shows the doc updates:

    Staging site example

  6. Review the changes on the staging site.

  7. Complete the following as necessary:

    • If the changes are acceptable, approve the pull request.
    • If the contributor needs to make changes, add a note to the pull request indicating what needs to be changed. Then repeat Steps 1-6 when the requested changes are made.

Next Step

Deploy the updates

Last update: June 26, 2020