Skip to content

docs: replace stale PRD references #126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bilby91 merged 1 commit into from
Aug 31, 2026
Merged

docs: replace stale PRD references #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions .dap/review/engineering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
10 changes: 6 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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

Expand Down