Commit guideline copies with projects and allow single-number versioning
This commit is contained in:
+39
-6
@@ -1,9 +1,42 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to this documentation repository, grouped by version and release date.
|
||||
Document versions of the individual guideline files are tracked separately in their headers.
|
||||
All notable changes to this documentation repository, grouped into numbered revisions (`v1`, `v2`, …)
|
||||
of the repository as a whole. There is no semantic version here — this repository has no manifest and
|
||||
ships documents, so it uses the same `v#` scheme as the documents themselves.
|
||||
|
||||
## 0.4.0 — 2026-08-18
|
||||
Individual guideline documents carry their own `Document Version` header, and the skills carry
|
||||
`metadata.version`; both are independent of the revisions below.
|
||||
|
||||
## v5 — 2026-08-18
|
||||
|
||||
### Added
|
||||
- `check_versions.py` — walks the sibling project directories, compares every `CLAUDE.md`,
|
||||
`AGENTS.md` and `DESIGN_DOCUMENT*.md` copy against its master here, and reports the ones that are
|
||||
behind or were edited in place. Standard library only; exits non-zero when anything needs
|
||||
attention
|
||||
- "Guideline copies in projects" section in `README.md` — the copies in project roots are now
|
||||
**committed** with each project, with the rationale and the three rules that keep them from
|
||||
drifting (never edit a copy, deviations go to `PROJECT.md`, sync commits stand alone)
|
||||
|
||||
### Changed
|
||||
- `README.md` step 3 of "Starting a new project": the guideline copies are committed with the
|
||||
project instead of being kept out of version control, and `Claude/CLAUDE.md` is named alongside
|
||||
`AGENTS.md` and the design document
|
||||
- `AGENTS.md` v6 → v7: the Git section said the opposite of the new policy — "Never commit shared
|
||||
documentation" is replaced by the rule that every core document is committed, must never be edited
|
||||
inside a project, and is synchronised in its own commit that stays out of the project `CHANGELOG.md`
|
||||
- `CLAUDE.md` added to the list of core root documents in `AGENTS.md` and in all five design
|
||||
documents, which had omitted it: `DESIGN_DOCUMENT.md` v9 → v10, `DESIGN_DOCUMENT_MODULE.md` v2 → v3,
|
||||
`Rust/DESIGN_DOCUMENT.md` v2 → v3, `Rust/DESIGN_DOCUMENT_LIB.md` v2 → v3,
|
||||
`DESIGN_DOCUMENT_GODOT.md` v2 → v3
|
||||
- `Python/TEMPLATE.md`: the note that the shared documents are "never committed" now matches the new
|
||||
policy — they stay out of the template, but the copies in a project are committed and never edited
|
||||
- `Project template/CHANGELOG.md` gained a "Versioning" section: semantic versioning stays mandatory
|
||||
for software projects, while documentation and other manifest-less repositories may use
|
||||
single-number revisions (`v1`, `v2`, …). This repository's own changelog was converted to that
|
||||
scheme and its revisions renumbered `0.1.0`–`0.4.0` → `v1`–`v4`
|
||||
|
||||
## v4 — 2026-08-18
|
||||
|
||||
### Added
|
||||
- Skill versioning: every `SKILL.md` now carries `metadata.version` — `changelog` v2, `check` v1,
|
||||
@@ -45,7 +78,7 @@ Document versions of the individual guideline files are tracked separately in th
|
||||
- Removed the misplaced lock-file rule from the Testing sections of `DESIGN_DOCUMENT_MODULE.md` (§9)
|
||||
and `Rust/DESIGN_DOCUMENT_LIB.md` (§8) — it already belongs to the Poetry / Distribution sections
|
||||
|
||||
## 0.3.0 — 2026-08-18
|
||||
## v3 — 2026-08-18
|
||||
|
||||
### Added
|
||||
- `Zscaler/ZSCALER_CERTIFICATE.md` — full certificate setup for Node, Python, git and cargo
|
||||
@@ -63,12 +96,12 @@ Document versions of the individual guideline files are tracked separately in th
|
||||
### Removed
|
||||
- `Zscaler/NODE_EXTRA_CA_CERTS.md`, superseded by `ZSCALER_CERTIFICATE.md`
|
||||
|
||||
## 0.2.0 — 2026-06-24
|
||||
## v2 — 2026-06-24
|
||||
|
||||
### Added
|
||||
- `Godot/DESIGN_DOCUMENT_GODOT.md` — Godot development guidelines (v1)
|
||||
|
||||
## 0.1.0 — 2026-05-25
|
||||
## v1 — 2026-05-25
|
||||
|
||||
### Added
|
||||
- `Rust/DESIGN_DOCUMENT.md` and `Rust/DESIGN_DOCUMENT_LIB.md` — Rust guidelines for applications and libraries (v1)
|
||||
|
||||
Reference in New Issue
Block a user