Record decisions as ADRs in docs/decisions

オープン
#493 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
52/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
github-actions, javascript

調査の方向性

Start by reading AGENTS.md, PRODUCT.md, and the related issues #491 and #492 to understand the existing decision and versioning guidance. Then inspect the repository’s documentation and CI setup to find where records and a generated index would fit. Done means the proposed ADR process, cross-repository decision location, backfilled records, and CI check are in place, with a later review of the upkeep cost.

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

説明

documentation

I want durable decisions recorded as Architecture Decision Records, so that people and AI agents can see why something was decided and do not undo it by accident. Example: "pivotkit has no scheduler" lives today in #165, PRODUCT.md and old discussions.

Plan

  • docs/decisions/ with MADR (minimal template), one decision per file, numbered, about one page.
  • Accepted records are not edited; a change is a new record that supersedes or amends the old one, linked both ways.
  • A short block in AGENTS.md: where the records are, what each status means (accepted is binding, proposed is context, superseded is history), and to stop and propose a new record when a task conflicts with an accepted one.
  • An index of accepted records, generated and checked in CI (numbers, links, status).
  • Backfill first the decisions agents have already questioned or undone; write "reason not recorded" where the reason is lost.
  • Each record links its issue; work and task state stay in issues.
  • Decide where decisions live that span repositories (pivotkit and its host integrations).
  • No records for reversible, low-impact choices.
  • Review after a few weeks whether it helps or only adds upkeep.

Relates to PRODUCT.md (#492) and the versioning policy (#491).

主要言語
JavaScript
スター
1
フォーク
1
平均マージ
3時間 34分
マージ済み PR(30日)
213

環境構築

はじめの一歩

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

eizedev/pivotkit のほかの issue

eizedev/pivotkit の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

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

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