Skip to content

Commit

Permalink
Merge pull request #3627 from newrelic/peer-review-edits
Browse files Browse the repository at this point in the history
Peer review edits
  • Loading branch information
bradleycamacho committed Aug 25, 2021
2 parents aae64ae + 672ead0 commit 34f28b1
Showing 1 changed file with 13 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -122,14 +122,21 @@ Now that your commits are available to everyone, you need to notify people that
To do this, you open a pull request:

1. On GitHub Desktop, click the blue **Create Pull Request button**.
2. This will open GitHub in your browser, and prompt you to fill in your pull request. Ensure you are merging from your branch into either the `main` or `develop` branch. If you scroll down, you can review all your commits to ensure they reflect all your changes.
2. This will open GitHub in your browser, and prompt you to fill in your pull request. Ensure you're merging from your branch into either the `main` or `develop` branch. If you scroll down, you can review all your commits to ensure they reflect all your changes.
3. Just like your commit description, your pull request description should be detailed and give the full context of your changes.
- Feel free to add any additional context here (issue or Jira number, SMEs, etc.)
4. Once you are satisfied with your pull request, click the green **Create pull request button**.
5. You can either publish the changes directly by approving the pull request yourself, or you can request for another Tech Writer to peer edit it.
- To request a review from another Tech Writer: in GitHub open the PR, navigate to the conversation **Conversation**, and then select or type in a reviewer name in the **Reviewer** section.
6. At the bottom the pull request page, you will see a **Checks** section. These checks ensure your PR does not break the build process of the site. Ensure all these checks pass before proceeding. The checks should finish within twenty minutes. If the Pull Request is urgent, you can skip the **AWS Amplify Console Web Preview ** check.
6. Once the pull request has passed the checks and it has been approved by another tech writer (or you are confident the changes are ready to be published), click the green **Merge pull request** button. This will merge your branch and commits into the repository and will begin the build process.
- To request a review from another Tech Writer: in GitHub open the PR, navigate to the **Conversation** section, and then select or type in a reviewer name in the **Reviewer** section.
4. Add any [relevant labels](/docs/style-guide/writer-workflow/github-intro) to your PR. If you do not add `from_tw`, the PR will not be automatically assigned to another writer for review.
5. Once you're satisfied with your pull request, click the green **Create pull request button**.
6. You can either publish the changes directly by approving the pull request yourself, or you can request for another Tech Writer to peer edit it.
7. At the bottom of the pull request page, you will see a **Checks** section. These checks ensure your PR doesn't break the build process of the site. Ensure all checks marked `required` pass before merging.
8. Once the pull request has passed the checks and it has been approved by another tech writer (or you are confident the changes are ready to be published), click the green **Merge pull request** button. This will merge your branch and commits into the repository and will begin the build process.

If you don't add the `from_tw` label when you first create a PR, it will not automatically assign a reviewer. If you forget to add the label before opening the PR:

1. Add the `from_tw` label.
2. Turn the PR into a draft PR.
3. Select the `PR is ready for review button` at the bottom of the page to reopen the PR. The PR should now have a reviewer.

## Preview a doc [#preview-doc]

Expand Down

0 comments on commit 34f28b1

Please sign in to comment.