Contributing by Reviewing
Hello dear reviewer and thank you for your desire to help out with the AguaClara textbook. This document contains everything you need to know to get started.
You can go to the Projects tab in this repository, found here, to see what's currently going on in Textbook land. As a reviewer, you will be looking at the projects named "Chapter: _______", as those are the projects that include creating and perfecting actual textbook content. Once you click on a project, you will see many columns. The ones that are relevant to you as an editor are:
- Needs Review
- Reviewer Approved
Even documents that have been reviewer approved, defined as having been reviewed by at least 3 people, should still be looked at and improved! The content of both columns is mostly GitHub issues, with one issue per textbook document. When you find a "Needs Review" or "Reviewer Approved" column that contains an issue, click on the issue name and click on the bottom button labeled "Go to issue for full details" in the sidebar that appears on the right-hand side of your screen. An image of this is displayed below.
Once you have opened up the issue page for a document that you want to edit, you can get started! At the top of the issue, you'll find a link to the document within the official textbook. Click it to start reviewing!
Any comment, question, or uncertainty you have, and we mean ANY, you can and should include in the document's issue page by scrolling to the bottom of the page and writing a comment. Every individual comment you make should begin with a check box before it so the writers can physically mark when they've addressed your comment. To make a check box, begin your comment with - [ ] An example of a comment on a document issue is shown below:
When you are commenting, it is helpful to "@" the person who is assigned to that issue to ensure they receive a notification that the draft has been reviewed.
And that's all you need to know! Thanks again for your awesome help in progressing AguaClara's mission of providing clean water on tap to everyone in the world!