Fix documentation inconsistencies and bump document versions
This commit is contained in:
+8
-1
@@ -1,6 +1,6 @@
|
||||
# AI Agents - Project Rules
|
||||
|
||||
**Document Version:** v5 (independent, incremented on structural changes)
|
||||
**Document Version:** v6 (independent, incremented on structural changes)
|
||||
|
||||
Language-agnostic rules for AI assistants (Claude Code, Cursor, Copilot, etc.).
|
||||
|
||||
@@ -68,6 +68,13 @@ Where this file and a design document disagree, **the design document wins**.
|
||||
- **Never commit shared documentation** (`AGENTS.md`, `DESIGN_DOCUMENT*.md`) — it comes from the documentation repository, not from the project
|
||||
- `README.md`, `PROJECT.md` and `CHANGELOG.md` **are committed** — they are project-specific
|
||||
|
||||
### Commit messages
|
||||
|
||||
- **Never sign commits with AI authorship** — no `Co-Authored-By: Claude` (or any other assistant), no "Generated with …" line, no tool name or emoji footer. The same applies to pull request descriptions and issue comments.
|
||||
- The commit author is the human running the tool; the message describes the change, nothing else
|
||||
- Single-line verbal style — "Add X", "Fix Y", "Refactor Z" — never a filename-style message
|
||||
- Written in English
|
||||
|
||||
## Versioning
|
||||
|
||||
- Follow semantic versioning (MAJOR.MINOR.PATCH)
|
||||
|
||||
+3
-1
@@ -1,10 +1,12 @@
|
||||
# CLAUDE.md
|
||||
|
||||
## First-time setup
|
||||
|
||||
**At the start of every new session, read all of the following files before doing anything else:**
|
||||
|
||||
- `CLAUDE.md` (this file)
|
||||
- `README.md`
|
||||
- `AGENTS.md`
|
||||
- `PROJECT.md`
|
||||
- `CHANGELOG.md`
|
||||
- `DESIGN_DOCUMENT*.md` (`DESIGN_DOCUMENT.md`, `DESIGN_DOCUMENT_MODULE.md`, `DESIGN_DOCUMENT_LIB.md` or `DESIGN_DOCUMENT_GODOT.md`)
|
||||
- `DESIGN_DOCUMENT*.md` (`DESIGN_DOCUMENT.md`, `DESIGN_DOCUMENT_MODULE.md`, `DESIGN_DOCUMENT_LIB.md` or `DESIGN_DOCUMENT_GODOT.md`)
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
---
|
||||
name: changelog
|
||||
description: Updates changelog in project
|
||||
metadata:
|
||||
version: v2
|
||||
---
|
||||
|
||||
Take known info and make changes to CHANGELOG.md to make them up-to-date.
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
---
|
||||
name: check
|
||||
description: Check for failed tests
|
||||
metadata:
|
||||
version: v1
|
||||
---
|
||||
Try running tests and investigate failed results
|
||||
@@ -1,6 +1,8 @@
|
||||
---
|
||||
name: commit
|
||||
description: Updates changelog and proposes a concise verbal git commit message
|
||||
metadata:
|
||||
version: v2
|
||||
---
|
||||
|
||||
1. Run the changelog skill: read git log and staged changes, then update CHANGELOG.md accordingly (same as /changelog).
|
||||
@@ -9,4 +11,5 @@ description: Updates changelog and proposes a concise verbal git commit message
|
||||
- Concise, verbal style — e.g. "Add X", "Fix Y", "Refactor Z"
|
||||
- NOT filename-style — never "update_something.py" or "changes to foo"
|
||||
- In English
|
||||
- **No AI authorship** — never append `Co-Authored-By: Claude`, a "Generated with …" line, or any tool signature or emoji footer. The same applies to pull request descriptions.
|
||||
- Do NOT run git commit — only propose the message and wait for user confirmation.
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
---
|
||||
name: documentation
|
||||
description: Updates documentation in project
|
||||
metadata:
|
||||
version: v1
|
||||
---
|
||||
Create or update documentation of project in docs/ folder. Documentation should contain description of each part of program and documentation of each function. Separate documents for each module. Write in markdown format.
|
||||
@@ -1,6 +1,8 @@
|
||||
---
|
||||
name: context
|
||||
name: documentation_context
|
||||
description: Compress docs/ into CONTEXT.md at project root — minimum tokens, lossless
|
||||
metadata:
|
||||
version: v2
|
||||
---
|
||||
|
||||
Read every `.md` file in `docs/`. Generate `CONTEXT.md` at the project root.
|
||||
Reference in New Issue
Block a user