Skip to content

A decision record states what it decides and not why the record exists, from now on #304

Description

@iderex

What is wrong

Decision records here explain what the record exists for instead of only stating what it decides, and the shape arrives with new records. Read at origin/main 7587fa7149657fdb9890b06fb3de2619329e079b after git fetch origin, against the remote-tracking ref rather than a working checkout:

git grep -nE "this (record|section) exists" origin/main -- . | wc -l
13

Three of those lines were found on 2026-08-09 and ten arrived since, each added with a new record. A sentence saying what a record exists to prevent tells a reader nothing the decision, the failure and the reversal condition do not already say.

Every one of the thirteen sits in a landed record or beside one, and docs/decisions/0001-decision-records.md allows three in-place edits, none of which is rewording a sentence. So the landed sentences stay, and what is missing is the rule for the next record and the reason the old ones keep their wording.

Done when

  • CONTRIBUTING.md, under ## Decisions, says that a record written from the day the rule lands states what it decides without explaining why the record exists or speaking about itself, that the records before it keep their wording deliberately because the register forbids the edit, and hands the reader the command above rather than a list.
  • docs/decisions/README.md points at that rule in one sentence and copies none of it.
  • Nothing under docs/decisions/ other than README.md changes, checked with git diff --stat.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions