Amendment records for accepted ADRs and confirmed requirements; flag edits to accepted elements without one

クローズ
#454 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
rust, yaml

調査の方向性

Start by reading the implementation of validate, show, export-html, and suspect, along with issue #433's changes work. Trace how accepted ADRs and requirements are represented and how policy-gated findings are produced. The issue is complete when amendment records can be validated and rendered, and amended decisions are marked by suspect, including the required owner reference for scope changes.

索引モデルが issue の本文から書いたものです。

説明

Problem

An ADR is accepted (or a requirement item confirmed by the owner), and later implementation shows it needs a change — e.g. a patch decided for one message type must also cover a second one. Today the author edits the accepted ADR in place and adds a prose note. Nothing records the amendment as data, and nothing stops an accepted element from being changed without one.

Proposal

  • An amendments: list on ADRs (and optionally Requirements): {date, by, reason, ref (question/review/commit), kind: clarification|scope-change}.
  • validate (policy-gated): an ADR with status: accepted whose body or decision fields changed since acceptance (via #433 changes against the commit that set accepted) without a matching amendment entry → finding; a scope-change amendment needs an owner reference (question answer or review).
  • show/export-html render the amendment history; suspect marks elements tracing to an amended decision.

Related

#232 (supersession, for replacing a decision rather than amending it), #443 (provenance of edits).

主要言語
Rust
スター
8
フォーク
1
平均マージ
3時間 35分
マージ済み PR(30日)
69

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

sjames/syscribe のほかの issue

sjames/syscribe の issue をすべて見る

似ている issue

Rust の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。