2.2 KiB
Документация WealthLedger
Перед изменением прочитай README и CONTRIBUTING, затем только затронутую тему. Docs объясняет систему; требования принадлежат основным спецификациям, реализация и coding conventions — соседним репозиториям.
Проверь существенные факты адресно по спецификациям, ADR и реализации с учётом веток и незакоммиченных изменений. Расхождение обозначь, не выбирая источник победителем автоматически. Перенос сохраняет полезное содержание и входящие ссылки. Docs описывает текущее устройство системы; история поставок остаётся в Git. Отчёты аудитов и исследований в docs не размещаются. Подтверждённые решения из исследований оформляются в ADR, системные знания — в тематических страницах.
Перед завершением проверь текст, диаграммы и маршруты чтения; выполни доступные проверки, включая новые файлы. Сохрани границы задачи и чужие изменения. Успех Markdown-проверки не заменяет смысловую сверку и не доказывает рендер диаграмм.
Ветки и релизы
Работа — в отдельной ветке от develop, затем PR в develop; в main напрямую
не пушить. Release/hotfix и синхронизация веток — по root README.
Commits и заголовки PR — Conventional Commits; для спецификаций допустим spec:.
Перед подготовкой релиза прочитай root README; версии вручную не повышать.