Start here
Who does what
Each language has reviewers, who are editors or translators, and a maintainer, @mmcky. This page describes what each role does during the initial translation of an edition.
Reviewers
In this manual, a reviewer is anyone who reviews a lecture. A reviewer is either an editor or a translator, and the rules for reviewing apply to both in the same way.
Editor
A language has at most one editor, the editor of record, who covers all of its editions. The editor reviews lectures and settles questions of terminology and house style with @mmcky. A language can also work without an editor: see A language without an editor.
Translator
A translator reviews lectures, suggests changes and answers questions about terms. A language can have more than one translator. The Japanese edition has two, and they divide the book between them by part.
What every reviewer does
- Reviews the whole lecture on its review pull request, by hand. See Review by hand.
- Suggests changes and comments on the pull request. See Reviewing on GitHub.
- Answers any questions on the follow-up issue. See After your review.
- When the review is complete, approves the pull request and mentions @mmcky in the approval summary. This tells @mmcky that the lecture is ready to merge.
Maintainer
The maintainer is Matt McKay, @mmcky. During the initial translation, @mmcky:
- drafts every lecture with the latest release of action-translation;
- applies your suggestions, with you credited as co-author;
- posts follow-up questions on an issue;
- improves the engine from each review, and checks the improved engine against the merged lecture;
- merges every pull request;
- maintains this manual.
In this phase, @mmcky merges every pull request because each merge is tied to an improvement in the engine.
A language without an editor
The Japanese edition has two translators and no editor. In a language without an editor, @mmcky rules on terms and house style after consulting the translators.
After the initial translation
Once an edition is complete and in production on a stable release of the engine, editors will approve and merge pull requests themselves. The process for that phase is still being designed. See Sync reviews.
What nobody needs to do
You do not need to tick checklists, add labels, or assign or close issues. Status comes from the pull requests. A lecture is done when its pull request is merged. The merge also closes the lecture's review issue.
Who is who
Each language page names the reviewers for that language and their roles: see Japanese and Malayalam. Languages lists every edition and its phase.