standardebooks/web
1
0
Fork 0
mirror of https://github.com/standardebooks/web.git synced 2025-07-13 18:11:52 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add instruction to lint at the start of a review

Browse source
This commit is contained in:
Weijia Cheng 2023-03-08 20:18:35 -08:00 • committed by Alex Cabal
parent 3d629cdefb
commit f4f7dfeb4c
1 changed files with 5 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

6
www/contribute/how-tos/how-to-review-an-ebook-production-for-publication.php
View file

@ -6,6 +6,10 @@ require_once('Core.php');
<h1>How to Review an Ebook Production for Publication</h1>
<p>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 <a href="/about#editor-in-chief">editor-in-chief</a>, and may be a member of the <a href="/about#editors">editorial staff</a>, 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 <a href="/manual">Manual of Style</a>, and note any discrepancies not listed below. Before any review steps, ensure the most recent version of the SE toolset is installed.</p>
<ol>
<li>
<h2>Lint</h2>
<p>Run <code class="bash"><b>se</b> lint <u>.</u></code> at the root of the project directory. If <code>lint</code> 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 <code>se-lint-ignore.xml</code> to suppress the false positives.</p>
</li>
<li>
<h2>Typogrify</h2>
<p>Run <code class="bash"><b>se</b> typogrify <u>.</u></code> at the root of the project directory. The <code>typogrify</code> command is almost always correct, but sometimes not all changes it makes should be accepted. To go over the changes <code>typogrify</code> may have made, run the following <code class="bash"><b>git</b></code> command to also highlight changes made to invisible or hard to differentiate Unicode characters:</p>
@ -159,7 +163,7 @@ require_once('Core.php');
</ul>
</li>
<li>
<h2>Lint</h2>
<h2>Lint again</h2>
<p>Run a final <code class="bash"><b>se</b> lint <u>.</u></code> check, and ensure it is silent. If any warnings and errors are produced, they must be noted and addressed.</p>
</li>
<li>