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
+14 -2
View File
@@ -12,9 +12,21 @@ Each version entry uses these sections (include only those that apply):
- **Removed** — removed features
- **Dependencies** — added, updated, or removed dependencies
## Versioning
Which scheme applies depends on what the repository ships:
- **Software projects — semantic versioning** `MAJOR.MINOR.PATCH`. The project manifest
(`pyproject.toml`, `Cargo.toml`, `project.godot`) is the source of truth, and this file is updated
**before** the version there is bumped.
- **Documentation and other non-program projects — single-number revisions** `v1`, `v2`, …
A repository with no manifest has nothing to derive a semantic version from, and
MAJOR/MINOR/PATCH carries no meaning for prose. Increment by one per released revision.
Pick one scheme per repository and do not mix them in this file.
## Rules
- Follow semantic versioning: `MAJOR.MINOR.PATCH`
- Newest version goes at the top
- Always update this file before bumping the version in the project manifest (`pyproject.toml`, `Cargo.toml`, `project.godot`)
- Document changes as they are made, not all at once at release time
- Always ask before bumping the version — never increment automatically