Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 20 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,22 +75,30 @@ the policy file, and the two forms the note names are checked as well. See

## Where a decision goes

A change that needs a decision is a GitHub issue in the
[Design record](.github/ISSUE_TEMPLATE/design.md) shape before a pull request
exists: the decision in the body, and the research in a comment that carries
the version, date and evidence of each claim. A Design record carries exactly
A proposal that benefits from design discussion can use a GitHub issue in the
[Design record](.github/ISSUE_TEMPLATE/design.md) shape: the proposed decision
in the body, and the research in a comment that carries the version, date and
evidence of each claim. A Design record carries exactly
one ruling label. The template files it with `ruling:pending`, and the ruling
is recorded by replacing that label with `ruling:accepted`, `ruling:rejected`
or `ruling:deferred`.

The repository receives only what runs, plus
[REFERENCE.md](docs/REFERENCE.md), which stays the normative statement of what
uphold does now. Tracked files carry no issue numbers, dates or status lines;
those stay in the Design record that rules the change.

Decisions live in Design record issues. [DESIGN.md](docs/DESIGN.md) explains
the current architecture; [REFERENCE.md](docs/REFERENCE.md) defines its
behavior. Retired decision files remain available in Git history.
The repository carries runnable content and current-state documentation,
including [DESIGN.md](docs/DESIGN.md) for the architecture and
[REFERENCE.md](docs/REFERENCE.md) for normative behavior.
Tracked files carry no issue numbers, dates or status lines;
those stay in the tracker and Git history.

The versioned source tree is authoritative for the delivered system: its
implementation, tests, [DESIGN.md](docs/DESIGN.md) and
[REFERENCE.md](docs/REFERENCE.md) describe the accepted architecture and
behavior together. Design record issues hold proposals, discussion and
historical context. An accepted proposal changes the delivered system only
Comment thread
coderabbitai[bot] marked this conversation as resolved.
through a reviewed repository change; an issue's status or age does not change
what a revision implements or whether it passes its checks. Keep the accepted
contract and the rationale needed to maintain it in the repository so a reader
can understand the system without consulting the issue tracker. Retired
decision files remain available in Git history.

## Working on the engine

Expand Down
234 changes: 231 additions & 3 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading