Skip to content

REVIEWING.md: point to the translation manual, and bring the review rules up to date - #29

Merged
mmcky merged 1 commit into
mainfrom
reviewing-md-manual
Oct 6, 2026
Merged

mmcky merged 1 commit into
mainfrom
reviewing-md-manual

Conversation

@mmcky

@mmcky mmcky commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

This brings REVIEWING.md in line with the QuantEcon Translation Manual, published at https://quantecon.github.io/project-translation/, before the first review round.

What changes

Before After
The process Written out in full here Linked to the manual: how a round works, reviewing on GitHub, what to look for, review by hand
House style and terms A table here, updated by hand The manual's Japanese page, which also has the settled terms, open questions and rulings log
When a review is complete "Say so on the pull request" Approve the pull request and mention @mmcky in the summary
AI tools An Assisted-by: line when an AI tool helped Review by hand: read and verify every edit yourself; checking tools such as dictionaries and spelling and grammar checkers are fine; AI and machine translation must not write the edits
Larger changes Commits mentioned in passing A commit to the branch for a larger change, alongside suggestions
Errors in the English An issue upstream, or mention it on the pull request An issue upstream, linked on the translated line; the review goes ahead without waiting for the fix
Merging Not mentioned Leave merging to @mmcky, although write access allows it

Unchanged: what the repository is, who reviews which lectures, and the lecture order.

Every manual link in the file was checked and resolves.

Assisted-by: Claude Code (Claude Opus 5.5)

🤖 Generated with Claude Code

…mcky; review by hand

The process now lives in the QuantEcon Translation Manual
(https://quantecon.github.io/project-translation/), and the house style,
terms, open questions and rulings log on its Japanese page. This file
keeps what belongs to the edition: what the repository is, who reviews
which lectures, and the order.

Rules brought up to date:
- a review is complete when the translator approves the pull request
  and mentions @mmcky (it was "say so on the pull request");
- review by hand: every edit read and verified by the translator, with
  no AI or machine translation writing it (replaces the Assisted-by
  section);
- a larger change can be committed to the branch instead of suggested;
- errors in the English: an issue upstream, linked on the line; the
  review is not held up.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings October 6, 2026 00:55

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

It is a documentation-only update with internally consistent links, no broken anchors, and no objective issues found.

Review effort: Balanced
Findings: None

What changed in this PR

This PR revises REVIEWING.md for the Japanese edition so it points to the canonical QuantEcon Translation Manual instead of restating the review process inline. The file now keeps only edition-specific content (what the repo is, who reviews which lectures, and the lecture order) and brief summaries that link out to the manual, while bringing several rules up to date ahead of the first review round.

Changes:

  • Added a "The manual" section linking to the key manual pages, and replaced the inline "How a round works", "House style", "What matters most", and "What to skip" sections with condensed summaries ("A round, in brief", "Policies in brief") that defer to the manual.
  • Updated review-completion, AI-tooling ("review by hand"), upstream-English-error, and merging guidance to match the new manual-driven process.
  • Trimmed the "Time" section and removed the standalone "AI tools" and "Errors in the English" sections.
File Description
REVIEWING.md Restructures the reviewer guide to reference the QuantEcon Translation Manual and updates the review, AI-use, upstream-error, and merging rules.

I verified that no other files reference REVIEWING.md and that the removed section anchors (e.g. #errors-in-the-english, #how-a-round-works) are not linked anywhere, so no internal cross-references were broken by the heading/section removals. The added manual links share a consistent base URL, and the upstream repository link matches the existing reference earlier in the file. No spelling, grammar, or consistency issues were found in the added prose.


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@mmcky
mmcky merged commit 981adf0 into main Oct 6, 2026
2 checks passed
@mmcky
mmcky deleted the reviewing-md-manual branch October 6, 2026 01:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants