Files
docs/AGENTS.md
T
ksv741 97069d6f6d
Docs security / security (pull_request) Successful in 6s
Docs verify / verify (pull_request) Successful in 11s
Conventional commits / commits (pull_request) Successful in 16s
Docs security / security (push) Successful in 9s
Docs verify / verify (push) Successful in 10s
docs: make documentation checks self-contained
2026-09-15 20:45:40 +03:00

2.4 KiB

Документация WealthLedger

Перед изменением прочитай README и CONTRIBUTING, затем только затронутую тему. Docs объясняет систему; требования принадлежат основным спецификациям, реализация и coding conventions — соседним репозиториям.

Проверь существенные факты по локальным тематическим страницам и ADR; внешние источники используй как справочные свидетельства, когда они доступны. Недостающие факты отмечай явно; инструкции и проверки не требуют других checkout. Расхождение обозначь, не выбирая источник победителем автоматически. Перенос сохраняет полезное содержание и входящие ссылки. Docs описывает текущее устройство системы; история поставок остаётся в Git. Отчёты аудитов и исследований в docs не размещаются. Подтверждённые решения из исследований оформляются в ADR, системные знания — в тематических страницах.

Перед завершением проверь текст, диаграммы и маршруты чтения; выполни доступные проверки, включая новые файлы. Сохрани границы задачи и чужие изменения. Успех Markdown-проверки не заменяет смысловую сверку и не доказывает рендер диаграмм.

Ветки и релизы

Работа — в отдельной ветке от develop, затем PR в develop; в main напрямую не пушить. Release/hotfix и синхронизация веток — по README. Commits и заголовки PR — Conventional Commits; для спецификаций допустим spec:. Перед подготовкой релиза прочитай местный README; версии вручную не повышать.