After your review

Your suggestions are applied

@mmcky applies your suggestions exactly as you wrote them, in one commit that credits you as co-author. GitHub shows your name on that commit, and the credit stays after the pull request is merged.

Any other change goes in a separate commit. Such a change might restore a formatting mark that a suggestion lost, or make a small fix to the text. @mmcky lists these changes for you to check, on the pull request or on the follow-up issue. If one of them is wrong, say so, and your version is restored.

If a suggestion is not applied, @mmcky replies on its thread and says why.

Changes you committed yourself are already on the pull request, under your name. A committed change that is not kept gets a reply on the pull request, saying why.

The merge

@mmcky then merges the pull request. The lecture's review issue closes at the same time. The merged lecture becomes the reference version of the lecture, which later versions of the engine are checked against. See How your review is used.

The follow-up issue

A review often raises questions. Examples are a word that you changed in one place and kept in another, or a pattern that could become a rule for later lectures. @mmcky collects these questions on a follow-up issue in your edition's repository and assigns it to you. The issue stays open after the pull request is merged, so the questions are not lost. Your answers decide what the engine learns for the lectures that follow.

In the Japanese edition, this issue is called a Decision issue. It goes to both translators, because a term chosen in one half of the book applies to the whole book.

1. @mmcky posts the questions. They are numbered. Each question gives the options, the line numbers concerned and our guess.
2. You answer by number, in one comment. One word for each question is often enough. Partial answers are welcome.
3. @mmcky reads your answers back. The reply restates your answers and says what will be done with each one. If anything in it is wrong, say so.
4. @mmcky closes the issue. The closing comment says where each answer went: a glossary entry, a rule or an engine release.

What changes because of you

• Each correction becomes a glossary entry, a rule or an automatic check in the engine, or it stays as your wording for that line only.
• A one-off preference fixes that lecture, but it may not change the engine.
• If an answer changes a lecture that is already merged, @mmcky opens a small pull request for those lines, and you approve it.
• The next review pull request lists what changed because of your review, under “New since the last draft”. See Reading a review pull request.

Between rounds

The next lecture's pull request may take some days to open, while @mmcky improves the engine and checks it against your merged version. See How a review round works.