-
Notifications
You must be signed in to change notification settings - Fork 6
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 that begin with "Chapter:", as those are the projects that include perfecting actual textbook content (as much as it is possible to create perfect content). Once you click on a project, you will see many columns. The ones that are relevant to you as an editor are the "Needs Review" and Reviewer Approved" columns. Even documents that have been reviewer approved, defined as having been reviewed by 3 people, should still be looked at and improved! The content of these 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 "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! On the issue you'll find a link to the document on the official textbook clearly written at the top of the page. Click it and start reviewing!
Any comment or question you have, and we mean ANY COMMENT OR QUESTION, you can and should include in a comment on the document's issue by scrolling to the bottom of the page. Every individual comment you make should begin with a check box before it, so the writers can mark and note 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:
Thanks again for your awesome help in progressing AguaClara's mission of providing clean water on tap to everyone in the world!