From 9a246d118b4baa0d333dd645b301ec8798f3e546 Mon Sep 17 00:00:00 2001 From: JeffreyChen Date: Thu, 24 Sep 2026 15:48:33 +0800 Subject: [PATCH] Require README.md and its translations to stay in sync with the code --- CLAUDE.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CLAUDE.md b/CLAUDE.md index 2a7a472a..0fdfe2f2 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -99,6 +99,15 @@ ruff check pybreeze/ # before committing non-trivia - Delete unused code immediately — no dead imports, unreachable branches, commented-out blocks, or `_old_` prefixes - Follow PEP 8 and standard Pythonic practice; `ruff` is the arbiter +## README & translations + +**`README.md` and every translated README must stay in sync with the code.** This repo ships +`README.md`, `README/README_zh-TW.md` and `README/README_zh-CN.md`. Any user-facing change — +features, commands, CLI flags, install/setup, configuration or requirements — updates `README.md` +**and every language variant in the same commit**, structure and content aligned. Never update one +language and leave the others stale. No README-parity test guards this, so it is a manual check +across the three files above. + ## Security **General**