AGENTS.md — ADR

Назначение уровня

Architecture Decision Records. Иммутабельные записи значимых архитектурных решений. Каждое решение — отдельный файл, пронумерованный.

Содержимое

adr/
├── AGENTS.md            # ← вы здесь
├── TEMPLATE.md          # шаблон нового ADR
├── 0001-...0017-*.md     # ранее принятые решения по архитектуре и данным
├── 0021-stdlib-first-go-service-runtime.md
├── 0022-gitlab-cicd-docs-as-code-and-release-governance.md
├── 0023-testing-pyramid-and-provider-contract-tests.md
├── 0024-supplier-connector-contract.md
├── 0025-price-and-stock-observation-extensions.md
├── 0026-marketplace-observations-and-seller-axis.md
├── 0027-html-scraper-connector-pattern.md
├── 0028-federated-identity-taxonomies.md
└── 0029-revision-based-incremental-sync.md

Правила

  • ADR иммутабелен после accepted. Новое решение → новый ADR со ссылкой superseded by.
  • Нумерация сквозная (0001, 0002, …). Не переиспользуется.
  • Slug в имени файла: kebab-case, краткий.
  • Короткий документ: 1–2 страницы.

Когда смотреть сюда

  • Нужно понять, почему было принято такое-то решение.
  • Принимаете новое решение — заведите новый файл из TEMPLATE.md.
  • Ищете альтернативы, рассмотренные ранее.

Когда НЕ смотреть сюда

  • Нужна текущая архитектура → ../principles.md, ../high-level-architecture.md.
  • Нужна схема БД → ../schemas/.

Жизненный цикл статусов

proposed → accepted → (deprecated | superseded by ADR-NNNN)

Связанные материалы