generated from hackforla/.github-hackforla-base-repo-template
-
-
Notifications
You must be signed in to change notification settings - Fork 5
How to Conduct a Peer Review
Sara E. Brady edited this page Nov 12, 2022
·
4 revisions
- Add an action item for conducting a peer review.
- Copy and paste the text below into a comment of your issue.
- Modify steps as needed for the specific draft that needs reviewed.
- Add issue label "ready for peer review" (if one is available).
- If you know who the peer reviewer is, then assign them to the issue.
- Place issue in "In progress (actively working)" column.
### Setup for a Peer Review
- [ ] Confirm with UX Lead that this document needs a peer review.
- [ ] Check if the Issue Overview clearly defines why this document needs to be created or updated. If it is not clear, add that information to the overview in 1-2 sentences.
- [ ] In the Resources, clearly identify the link to the document being created or updated that requires a peer review (use subheadings if needed).
- [ ] Copy and paste the Action Items for Peer Review into a comment of the issue.
- [ ] Customize the Action Items according (adding items that are more relevant to this issue and removing items that are less relevant).
- [ ] If you have a specific task that you want the Peer Reviewer to accomplish for their peer review that is nuanced to your issue, add that as a final action item to the list.
- [ ] For a spreadsheet review, add a column and label it "Peer Reviewer Questions and Feedback." If this step is not needed, remove this step.
- [ ] Determine who will do the peer review and unassign yourself to this issue and assign the peer reviewer to this issue.
### Action Items for Peer Review
- [ ] Review this issue
- [ ] Read the issue overview to learn about why this document was created.
- [ ] Locate draft of the document or spreadsheet in the Resources.
- [ ] Review draft
- [ ] Preview the draft quickly to get a sense of how the draft is structured and the type of content.
- [ ] Review the structure of the draft to ensure that the headings (in a Google Doc) or columns (Google Sheet) are clearly identified.
- [ ] Determine if the information is communicated in a way that is concise, precise, and free from jargon.
- [ ] Identify whether the draft adheres to the basic branding guidelines for the project (see Branding or Design wiki link in Resources).
- [ ] Provide feedback
- [ ] Add feedback in the form of (1) questions and/or (2) explicit instructions for how the content should be improved. Feedback in a Google Doc should be given in the form of document comments. Feedback in a Google Sheet should be given in the column labeled for Peer Review.
- [ ] Determine the accuracy of the content for each section (doc) or row (sheet). If you find an inaccuracy, error, or mis-categorization, explain how the information presented could be improved.
- [ ] For each suggested improvement, provide a link or reference within your comment to justify your suggestion.
- [ ] Specific to this issue:
- [] [REPLACE WITH STEPS THAT ARE SPECIFIC TO THIS ISSUE]
- [ ] Once all the steps have been completed, reach out to the original owner of this issue to determine if they can complete the next steps in the issue.