ru-normalizr AGENTS.md

ru-normalizr — Russian text normalization for TTS/NLP

Core principle

Generalizable, morphology-aware rules. Never add a one-off replacement for a single token or phrase — if a bug reproduces, fix the rule, not the string. Target production-ready quality: no quick hacks or fragile workarounds unless explicitly requested.

Changelog and versions

• Any user-visible change goes to CHANGELOG.md under ## Unreleased.
• Never bump the version outside explicit release tasks. On release, keep __init__.py, pyproject.toml, and CHANGELOG.md in sync (see VERSIONING.md).

General rules

Write README.md, documentation, MRs and UI text in Russian. Target production-ready quality: no quick hacks, temporary workarounds, or fragile solutions unless explicitly requested. Never commit secrets or .env files; never print secrets to logs, error messages, events, or API responses. YAGNI: Do not add infrastructure or integrations nobody asked for (monitoring, metrics, tracing, admin panels). Propose first; add only after explicit approval. Whenever you identify a workaround, defect, or reliability risk, please highlight it and suggest a proper fix.

Commits and branches

• Commit completed work yourself when a task or phase is finished — atomic conventional commits.
• Before every commit, run the project's lint, type-check, and test commands. Defaults when none are configured: Python — uv run ruff check . && uv run pyright (plus uv run pytest if tests exist); TypeScript — npm run check, otherwise the project's lint/type-check scripts plus relevant tests. Fix all errors caused by your changes.
• Commit messages and MR titles follow Git Atomic Conventional Commits: keep the type and scope in English (feat(auth):, fix(db):), write the description after the colon in Russian — e.g. feat(consent): интегрировать Яндекс.Метрику.
• Maintain .gitignore yourself: add generated, local, temporary, cache, build, and environment files as they appear.
• In the Bash tool, pass multi-line commit messages via -m with a regular double-quoted string (or heredoc), NOT PowerShell @'...'@ syntax — the @ leaks into the message text.
• Do not create new branches without explicit user confirmation. Work in the current branch; сreate a branch only on explicit request.
• On a push request: (1) run lint/type-check/tests; (2) push the current branch; (3) create annotated tag tested-N (next N from git ls-remote --tags origin) on the pushed commit and push it. Skip step 3 if 1 or 2 failed. Never move or delete existing tags.