3.2 KiB
Документация WealthLedger
Перед изменением прочитай README и CONTRIBUTING,
затем только затронутую тему. Docs объясняет систему; требования принадлежат
основным спецификациям, реализация и coding conventions — соседним репозиториям.
До edits найди/создай подходящую Gitea Issue, проверь AC и ветку; чтение
допускается без Issue. Общий маршрут — Engineering Workflow
(main#28; после merge — актуальная версия develop).
Проверь существенные факты по локальным тематическим страницам и ADR; внешние источники используй как справочные свидетельства, когда они доступны. Недостающие факты отмечай явно; инструкции и проверки не требуют других checkout. Расхождение обозначь, не выбирая источник победителем автоматически. Перенос сохраняет полезное содержание и входящие ссылки. Docs описывает текущее устройство системы; история поставок остаётся в Git. Отчёты аудитов и исследований в docs не размещаются. Подтверждённые решения из исследований оформляются в ADR, системные знания — в тематических страницах.
Перед завершением проверь текст, диаграммы и маршруты чтения; выполни доступные проверки, включая новые файлы. Сохрани границы задачи и чужие изменения. Успех Markdown-проверки не заменяет смысловую сверку и не доказывает рендер диаграмм.
Ветки и релизы
Работа — в issue-linked ветке от develop, затем PR в develop; в main напрямую
не пушить. PR сливается squash или rebase-merge; merge-коммит не используется.
main обновляется только fast-forward из develop, поэтому origin/main
всегда предок origin/develop:
git merge-base --is-ancestor origin/main origin/develop. Срочный fix —
обычная ветка fix/* от develop; пути hotfix от main нет.
Релиз — по README.
Commits и заголовки PR — Conventional Commits со ссылкой на Issue (кроме release);
для спецификаций допустим spec:.
Перед подготовкой релиза прочитай местный README; версии вручную не повышать.