Commit guideline copies with projects and allow single-number versioning

This commit is contained in:
Jan Doubravský
2026-08-18 13:08:06 +02:00
parent 78f1f863bf
commit 950e946004
11 changed files with 300 additions and 25 deletions
+2 -2
View File
@@ -1,6 +1,6 @@
# Python Development Guidelines
**Document Version:** v9
**Document Version:** v10
> **Note on Versioning:**
> - This document version is independent — reused across projects
@@ -19,7 +19,7 @@
All detailed documentation of features and systems belongs in the `docs/` folder, not in the project root.
The root directory contains only the core documents: `README.md`, `AGENTS.md`, `DESIGN_DOCUMENT.md`, `PROJECT.md`, `CHANGELOG.md`.
The root directory contains only the core documents: `README.md`, `CLAUDE.md`, `AGENTS.md`, `DESIGN_DOCUMENT.md`, `PROJECT.md`, `CHANGELOG.md`.
---
+2 -2
View File
@@ -1,6 +1,6 @@
# Python Library Development Guidelines
**Document Version:** v2
**Document Version:** v3
> **Note on Versioning:**
> - This document version is independent — reused across projects
@@ -18,7 +18,7 @@
All detailed documentation of features and systems belongs in the `docs/` folder, not in the project root.
The root directory contains only the core documents: `README.md`, `AGENTS.md`, `DESIGN_DOCUMENT_MODULE.md`, `PROJECT.md`, `CHANGELOG.md`.
The root directory contains only the core documents: `README.md`, `CLAUDE.md`, `AGENTS.md`, `DESIGN_DOCUMENT_MODULE.md`, `PROJECT.md`, `CHANGELOG.md`.
---
+3 -2
View File
@@ -26,8 +26,9 @@ template/
└── test_constants.py # Basic test
```
`AGENTS.md` and `DESIGN_DOCUMENT.md` are **not** part of the template — they are copied
into the project root from the documentation repository and are never committed.
`CLAUDE.md`, `AGENTS.md` and `DESIGN_DOCUMENT.md` are **not** part of the template — they are copied
into the project root from the documentation repository, which stays their source of truth. The
copies themselves **are committed** with the project and are never edited in place.
## Key Features