Handling Pull Requests
You may get pull requests submitted against your guidebook.md file as the editing cycle continues. Those are edits that are suggested by someone else, such as writer's from Info Dev who are cleaning up language and enforcing stylistic consistency.
-
In order to view the changes, first open your repository on the GitHub website. Navigate to that pull request by clicking the Pull Request tab, then clicking on the title of the request.
-
Click on the Files Changed Tab and then Unified. This will show you the before and after, with the original on the left and the proposed changes on the right.
-
If you are good with the changes proposed, then you can accept the changes. To do that, click the "Conversations" tab then enter a commment such as "Accepting copy edits" and click the green "Merge Pull Request" button.
-
That is all you need to do to to incorporate the suggested changes.
-
If you don't agree with some of the edits, then you can request revisions. To do that, click back to the "Files Changed" tab. Click the green "Review Changes" button, which will open up a modal window.
-
In the "Review Summary" check box, explain what you don't agree with. Be sure to select the "Request Changes" option then click the green "Submit Review" button.
-
After you submit that, you will see the "Changes requested" notification on the pull request.
-
After the editor makes the changes, you will get a notification via email. The update will come in the form of a new pull request. If you look at the new one and are satisfied, then go first to the original pull request and approve changes, then merge in as above.
-
After that, go to the subsequent pull request and merge those changes as well. You want to do them in the order created so that the edits are applied in that order. If in doubt, feel free to reach out and ask for help from the editor.
Note If these pull requests are open for long enough, administrators may accept them on your behalf. This will not happen if the content is changing, but for minor formatting edits or to fix broken imports this may be the case. It is important that you sync frequently to avoid getting conflicts when you modify files. Any time you return to editing your guidebook, always begin with a sync.
