Review Process

Quality control is the best!

Related Tools/Scripts

Install stylecheck: sudo npm install -g @bhdirect/stylecheck:

Use stylecheck (in /dev/epub/isbn/): stylecheck me

Admin

Developer

As the developer, it is your responsibility to ensure that the EPUBs you develop are completed according to the Style Guide by performing a thorough self-review.

• Do not move a card into "Ready for Review" unless you have completed the entire review process on your own project.
• Peer Review is meant to be a "second set of eyes" because humans make mistakes. It should not be used as an error catch-all for projects that are not fully-developed. That approach is disrespectful towards your fellow team members and their time.
• Placing a card in "Ready for Review" means you affirm that development is complete and ready for delivery to paying customers!

1. If the project passes a thorough self-review and you feel in good conscience that it is ready to be sold, move the Trello card to “Ready for Review”
2. Once the card is in “Review Issue Resolution,” resolve issues with commits using 1 commit for each issue, following the commit style guidelines.
3. When you are done with issue resolution, move the card to “Ready for Review” (not “In Review”).

Reviewer

1. Add yourself to the Harvest project and track time against “Review”
2. Add yourself to the Trello card and move it to “In Review”
3. Add any issues to the repo in GitHub (20-second how-to GIF). Note: Issues should be based on the styleguide and not personal preference. If you have suggestions for the developer, use the “enhancement” tag when you are creating the issue in GitHub.
4. When complete (and if there are issues), move the card to “Review Issue Resolution”
5. If there are no issues (usually 2nd or later review), move the card to “Ready for Release”

Checkpoint!

Make sure the EPUB passes EpubCheck and stylecheck before moving forward! If you are reviewing another developer's project, do not proceed with Review, and don't open issues in GitHub based on these tools. Simply move the Trello card to Review Issue Resolution and alert the developer.

What to Look For

• If any Structural or Markup Issues exist, make sure they should. If any of them are issues that should have been addressed, follow the warning above and notify the developer.
• In Commentaries or Bibles, if there is missing Scripture Context markup, make sure the epub content covers that Scripture passage before adding it to GitHub as an issue.

• Check all views in stylecheck to ensure everything is on the up and up.

  • TOC: ensure the toc accurately reflects the structure of the book. Click on a few links and verify they point to the correct locations. Also look for any spelling or capitalization errors.
  • Heading Outlines: ensure each heading outline is correct. Choose semantics over styling and check for spelling, capitalization, and punctuation errors.
  • Lists: ensure the lists render well and do not duplicate item indicators. In the markup, make sure the .none class is used only where no item indicators are intended.
  • Tables: ensure tables render well in the smaller viewports provided by stylecheck. Look for anything out of sorts.
  • Quotes: look for anything out of sorts here. Ensure scripture quotes and normal blockquotes were each tagged appropriately.
  • Asides: look for anything out of sorts here. In general, asides should be brief and tangential. Long asides are an indication something should probably be tagged differently.
  • Images: make sure the images are clear and sized properly. Check for any images in the image folder that aren’t used in the epub and can be removed for more space.

• Run review regexes to find anything that was missed. Reference the RegEx Library for a list of helpful regexes.