mirror of
https://github.com/GoodOlClint/PSProxmoxVE.git
synced 2026-09-04 03:05:32 +00:00
docs: migrate DECISIONS.md to house-format ADRs, and retire the review folder (#131)
D001-D021 become ADR 0001-0021 in docs/decisions/, one decision per file. D017's PESTER_VERSION amendment was a second decision in one entry and becomes ADR 0022. ADR 0023 records the migration and reverses the lane2-change-plan ruling that deliberately kept DECISIONS.md until the CI lane work landed. DECISIONS.md is reduced to a stub with a D-to-ADR redirect table, so the four released CHANGELOG entries and older issue bodies that cite it degrade to a redirect rather than a dead reference. docs/review/ and docs/lane2-change-plan.md are deleted (ADR 0024). Of 91 findings, 83 were resolved and six of the seven still open were already GitHub issues; F021 was the exception and is now #130. CLAUDE.md's Key Conventions list gains the two rules it was missing and becomes the checklist, with the ADRs carrying rationale.
This commit is contained in:
committed by
GitHub
parent
c3f051bba5
commit
b90791e2bf
@@ -78,6 +78,5 @@ pve force-cleanup
|
||||
|
||||
Before writing new code, read these files to understand established patterns and open issues:
|
||||
|
||||
- [`DECISIONS.md`](../DECISIONS.md) — architectural decisions and anti-patterns that must not be reintroduced.
|
||||
- [`docs/review/findings.json`](../docs/review/findings.json) — stable findings database (IDs F001… are permanent; resolved findings are marked, never deleted).
|
||||
- [`docs/review/REVIEW_REPORT.md`](../docs/review/REVIEW_REPORT.md) — latest full review report.
|
||||
- [`docs/decisions/`](../docs/decisions/) — architectural decision records, one per file: what was chosen, what was rejected, and why. The rules themselves are the "Key Conventions" list in [`CLAUDE.md`](../CLAUDE.md).
|
||||
- The repository's open GitHub issues — all outstanding work is tracked there.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
name: PVE Package Currency
|
||||
|
||||
# Lane 2 of the two-lane CI split (see docs/lane2-change-plan.md).
|
||||
# Lane 2 of the two-lane CI split (see docs/decisions/0017-ci-runs-two-lanes-a-pinned-gating-lane-and-a-report-only-currency-lane.md).
|
||||
#
|
||||
# Lane 1 (integration-tests.yml) pins the nested nodes to what the ISO ships
|
||||
# and never upgrades — that pin is what makes it a stable merge gate.
|
||||
|
||||
@@ -191,7 +191,7 @@ jobs:
|
||||
run: bash tests/infrastructure/scripts/preflight-cleanup.test.sh
|
||||
|
||||
# The pin lives in two files; split-brain is exactly the unexplained
|
||||
# breakage D017 exists to prevent, so assert they agree.
|
||||
# breakage ADR 0022 exists to prevent, so assert they agree.
|
||||
- name: Pester pin agrees across workflow and image
|
||||
run: |
|
||||
wf=$(sed -n 's/^ PESTER_VERSION: *//p' .github/workflows/unit-tests.yml)
|
||||
|
||||
Reference in New Issue
Block a user