Template
Оптимизация описания
This commit is contained in:
@@ -0,0 +1,24 @@
|
||||
# Архитектурные решения
|
||||
|
||||
Храни принятые и исторические решения в этом каталоге. Создавай ADR для
|
||||
долгосрочных архитектурных решений, которые влияют на будущую разработку;
|
||||
не создавай ADR для каждого change или временной детали реализации.
|
||||
|
||||
## Именование и статусы
|
||||
|
||||
- Имя файла: `ADR-<номер>-<краткое-описание>.md`, например
|
||||
`ADR-0001-use-postgresql.md`.
|
||||
- Используй четырёхзначную последовательную нумерацию. Следующий номер на
|
||||
единицу больше максимального; номера не переиспользуются.
|
||||
- Используй статусы `Proposed`, `Accepted`, `Rejected` и `Superseded`.
|
||||
- ADR становится действующим только после явного принятия владельцем решения.
|
||||
- Отклонённые и заменённые ADR сохраняй как историю.
|
||||
|
||||
Перед архитектурным изменением читай применимые ADR со статусом `Accepted`.
|
||||
При пересмотре принятого решения создай новый ADR, укажи заменяемый ID в
|
||||
`supersedes`, а в прежнем ADR — новый ID в `superseded-by`. Не меняй принятое
|
||||
решение задним числом.
|
||||
|
||||
Новый ADR создавай из `ADR-template.md` как задачу OpenSpec Change. Добавь в
|
||||
`tasks.md` отдельную задачу на его создание со статусом `Proposed`; не принимай
|
||||
решение самостоятельно.
|
||||
Reference in New Issue
Block a user