Перейти к содержанию

srekit rfc

Сгенерировать RFC / ADR скаффолд с секциями Context, Decision, Alternatives, Consequences, References. Поле status валидируется.

Синопсис

srekit rfc --title TITLE [flags]

Флаги

Флаг Обязательный Описание
--title да Тема RFC
--status нет proposed, accepted, rejected, superseded, deprecated. Default: proposed.
--author нет Переопределить автора (резолв как у license)
--email нет Переопределить email

Плюс общие output-флаги. Default имя файла: rfc-<slug-of-title>.md.

Примеры

srekit rfc --title "Migrate to gRPC" --stdout

Apgrade с принятым решением:

srekit rfc --title "Migrate to gRPC" --status accepted --out rfc-grpc.md

Невалидный status отклоняется:

srekit rfc --title "X" --status maybe --stdout
# Error: --status must be one of proposed|accepted|rejected|superseded|deprecated

Структура секций

  • Front matter: title, status, tags, id
  • Контекст (Context)
  • Решение (Decision)
  • Альтернативы (Alternatives)
  • Последствия (Consequences) — разбито на Positive / Negative / Neutral
  • Ссылки (References)

Структура данных для шаблона

rfc шипится как v1 YAML-артефакт (internal/tmpl/templates/rfc.yaml) — frontmatter (id, status, type: rfc, title, deciders, supersedes, …), H1 (RFC-<shortID> — <title>), meta_bullets, секции (context, decision, alternatives_considered, consequences, references). Template-выражения обращаются к .Meta.<Field> для ID, Title, Status, Now, Author.Name, Author.Email. См. srekit postmortem для полной схемы.

См. также