From 0ee0917af55362d51c87bcfbf0e3f4e11bee9286 Mon Sep 17 00:00:00 2001 From: ScuroNeko Date: Thu, 26 Mar 2026 23:06:05 +0300 Subject: [PATCH] Update repo agent documentation rules Require paired English and Russian docs when expanding project documentation Clarify changelog handling for main repo changes and keep rc.12 notes aligned Ignore local editor and Codex config directories in git --- .gitignore | 4 +++- AGENTS.md | 9 ++++++++- CHANGELOG.md | 2 +- 3 files changed, 12 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 3baab3b..88b114b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ .idea/ -test/ .wiki/ +.vscode/ +test/ +.codex/ diff --git a/AGENTS.md b/AGENTS.md index c40597f..8deb1aa 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -22,6 +22,12 @@ Review the codebase with focus on: - When feasible, make small, high-confidence improvements directly. - When uncertain, state confidence level and evidence. +## Documentation languages +- When creating or expanding project documentation, generate and maintain both English and Russian versions in the same turn whenever reasonably possible. +- For wiki pages, prefer paired pages such as `Page.md` and `Page-RU.md`. +- Keep English and Russian pages aligned in structure, major examples, and user-facing guidance. +- If only one language can be updated safely in the current turn, explicitly say which language is lagging and why. + ## Go review expectations Check for: - bugs, fragile logic, invalid assumptions, nil handling issues, resource leaks; @@ -77,7 +83,8 @@ Before finalizing changes, run the relevant project checks when available: Prefer the repository’s documented commands. If multiple choices exist, use the most standard and least destructive ones first. ## Versioning and changelog -- After every code or documentation change, update `CHANGELOG.md`. +- After every code or documentation change in the main repository, update `CHANGELOG.md`. +- Changes made only inside the `.wiki/` repository do not require a `CHANGELOG.md` update. - Add changes only to the section for the next version after the latest published git tag. - The agent must check the latest published tag, `CHANGELOG.md`, and `utils/version.go` before editing the changelog. - The agent must verify that the target changelog version matches the version declared in `utils/version.go`. diff --git a/CHANGELOG.md b/CHANGELOG.md index ae5b957..3ae8d46 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,8 +15,8 @@ - `AGENTS.md` now also defines a short commit-message format: one summary line plus up to three high-signal detail lines. - `AGENTS.md` now explicitly requires each commit-message detail line to be placed on its own new line. - `AGENTS.md` now also requires commit messages to be emitted as a plain multiline block instead of collapsed prose or list formatting. +- `AGENTS.md` now requires new or expanded project documentation to be maintained in both English and Russian whenever reasonably possible. - Payload-type comments and docs now distinguish between the bot's default payload type and keyboard-local overrides. -- The wiki `Start here` section now has substantive first-pass documentation for setup, commands/plugins, and `MsgContext`. - Version constants were bumped to `v1.0.0-rc.12`. ### Fixed