Content Review Workflow
As soon as a change has been made or new content has been added, these can be proofread by a so-called pull request.
The proofreader can quickly review the changes via the web interface and make corrections directly before they are published.
There are several ways to go to a pull request. Here we have listed two simple ways:
-
via the EMail you should have received
-
or directly by going to www.github.com
To get an overview of the changes, you can go there via the menu item files changed.
and for each file, each changed or added line is highlighted for you. Toggle the "split view" (if it suits you more) - it enables you to see the old version on the left, and the new version on the right side. The new lines (changed or added ones) are highlighted in green.
If a line doesn't need to be edited by you, you don't need to do anything.
If you want to change it, click on the + symbol on the left side of the line, click on the icon labeled with (2) in the screenshot, change the sentence (3), click "Start a Review" (4)
Tip: You should know a little bit about the markdown syntax. Here you can find some information about markdown .
When you are finished reviewing all changes in all files, confirm your review by: click "Review Changes" (1), click "Request Changes" (2), click "Submit Review" (3)
Click on "Conversation"
Just for your information: Here, you can see an overview of all the changes you've made.
To let the administrators know that the changes can be published, the comment function in the pull request can be used.
Scroll to the bottom of the screen, and tag a user. To do that, type an @ in the text field. A popup occurs, where you see available usernames. When you are not sure who you should choose, choose the owners of the repository.
Your work is done!