From f4f7dfeb4c96b3031927d6c2d52761bc786cddbb Mon Sep 17 00:00:00 2001 From: Weijia Cheng Date: Wed, 8 Mar 2023 20:18:35 -0800 Subject: [PATCH] Add instruction to lint at the start of a review --- .../how-to-review-an-ebook-production-for-publication.php | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/www/contribute/how-tos/how-to-review-an-ebook-production-for-publication.php b/www/contribute/how-tos/how-to-review-an-ebook-production-for-publication.php index 01c82f81..e0961dfa 100644 --- a/www/contribute/how-tos/how-to-review-an-ebook-production-for-publication.php +++ b/www/contribute/how-tos/how-to-review-an-ebook-production-for-publication.php @@ -6,6 +6,10 @@ require_once('Core.php');

How to Review an Ebook Production for Publication

After an ebook production is completed, it must go through rounds of review before it is published to ensure the appropriate production quality is assured. Reviewers are assigned by the editor-in-chief, and may be a member of the editorial staff, or an experienced Standard Ebooks producer. Below is a helpful step-by-step checklist for reviewers of ebook productions. The checklist is by no means exhaustive, but serves as a good starting point for the proofreading process. Reviewers should keep in mind the standards enumerated in the Manual of Style, and note any discrepancies not listed below. Before any review steps, ensure the most recent version of the SE toolset is installed.

    +
  1. +

    Lint

    +

    Run se lint . at the root of the project directory. If lint surfaces any nontrivial errors, you should direct the producer to fix the errors before proceeding. If there are false positives, the producer should create an se-lint-ignore.xml to suppress the false positives.

    +
  2. Typogrify

    Run se typogrify . at the root of the project directory. The typogrify command is almost always correct, but sometimes not all changes it makes should be accepted. To go over the changes typogrify may have made, run the following git command to also highlight changes made to invisible or hard to differentiate Unicode characters:

    @@ -159,7 +163,7 @@ require_once('Core.php');
  3. -

    Lint

    +

    Lint again

    Run a final se lint . check, and ensure it is silent. If any warnings and errors are produced, they must be noted and addressed.