diff --git a/.dap/review/engineering.md b/.dap/review/engineering.md index 860cb85..d0d4c08 100644 --- a/.dap/review/engineering.md +++ b/.dap/review/engineering.md @@ -16,7 +16,8 @@ the `Fixed` entries in [`CHANGELOG.md`](../../CHANGELOG.md) — each one has alr escaped to `main` at least once. Lines that never fire in review should be deleted; a checklist nobody reads is worse than a short one. -**Read these first**, from the base ref: [`PRD.md`](../../PRD.md) (scope and non-goals), +**Read these first**, from the base ref: [`README.md`](../../README.md) (supported +backends, spec compliance, and out-of-scope capabilities), [`CONTRIBUTING.md`](../../CONTRIBUTING.md), and whichever record under [`design/`](../../design) the diff touches. A change that contradicts its own design record is a finding, and you cannot see that without opening the record. @@ -146,8 +147,9 @@ Do not file these here: - Style, formatting, naming, and lint-adjacent nits — `golangci-lint` runs in CI and owns them. A finding that `make lint` would have produced is noise. -- Scope objections already settled by [`PRD.md`](../../PRD.md) §4 Non-goals, and the - documented `Known limitations` in the CHANGELOG. Absence of a non-goal is not a defect. +- Scope objections already settled by the capability matrix and `Out of scope` section in + [`README.md`](../../README.md), and the documented `Known limitations` in the CHANGELOG. + Absence of a non-goal is not a defect. - Dependency version bumps with no code change, beyond an actual incompatibility you can point at in the diff. - The Swift bridge under `applecontainer-bridge/` unless the diff touches it. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7bbeaae..cf9c04e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,10 @@ # Contributing Thanks for your interest. This project is in early alpha — the API is not -stable and the public scope is defined by [PRD.md](PRD.md). Issues and PRs -that fall outside the PRD's scope (see §4 Non-goals) will likely be closed -with a pointer to the PRD. +stable and the public scope is summarized by the supported backends and +spec-compliance matrix in [README.md](README.md). Issues and PRs that fall +outside the documented scope will likely be closed with a pointer to that +matrix. ## Dev setup @@ -34,7 +35,8 @@ make lint - Keep PRs focused; one logical change per PR. - Run `make lint test` locally before pushing. - Add or update tests for behavior changes. -- Reference the relevant PRD section in the PR description when applicable. +- Reference the relevant design record or README capability in the PR description when + applicable. ## Reporting issues