Honza/SQLmem
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation updated

Browse Source
This commit is contained in:
Jan Doubravský
2026-08-18 13:28:01 +02:00
parent a627ea88a4
commit 7cf235db83
3 changed files with 19 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+15 -11
View File
@@ -1,19 +1,22 @@
# AI Agents - Project Rules # AI Agents - Project Rules
**Document Version:** v6 (independent, incremented on structural changes) **Document Version:** v8 (independent, incremented on structural changes)
Language-agnostic rules for AI assistants (Claude Code, Cursor, Copilot, etc.). Language-agnostic rules for AI assistants (Claude Code, Cursor, Copilot, etc.).
Everything language-specific — package manager, formatter, linter, test framework, Everything language-specific — package manager, formatter, linter, test framework,
logging library, line length, project layout — lives in the matching design document: logging library, line length, project layout — lives in the matching design document:
| Project type | Design document | | Project type | Design document |
|--------------------|------------------------------| |--------------------|------------------------------------|
| Python application | `DESIGN_DOCUMENT.md` | | Python application | `DESIGN_DOCUMENT_PYTHON.md` |
| Python library | `DESIGN_DOCUMENT_MODULE.md` | | Python library | `DESIGN_DOCUMENT_PYTHON_MODULE.md` |
| Rust application | `DESIGN_DOCUMENT.md` | | Rust application | `DESIGN_DOCUMENT_RUST.md` |
| Rust library | `DESIGN_DOCUMENT_LIB.md` | | Rust library | `DESIGN_DOCUMENT_RUST_LIB.md` |
| Godot | `DESIGN_DOCUMENT_GODOT.md` | | Godot | `DESIGN_DOCUMENT_GODOT.md` |
The language is part of the file name, so a project that mixes languages carries one design document
per language and nothing collides.
Where this file and a design document disagree, **the design document wins**. Where this file and a design document disagree, **the design document wins**.
@@ -34,7 +37,7 @@ Where this file and a design document disagree, **the design document wins**.
- Source code, tests and detailed documentation each have their own directory — the concrete layout is in the design document - Source code, tests and detailed documentation each have their own directory — the concrete layout is in the design document
- Detailed documentation belongs in `docs/`, never in the project root - Detailed documentation belongs in `docs/`, never in the project root
- The project root holds only the core documents: `README.md`, `AGENTS.md`, `DESIGN_DOCUMENT*.md`, `PROJECT.md`, `CHANGELOG.md` - The project root holds only the core documents: `README.md`, `CLAUDE.md`, `AGENTS.md`, `DESIGN_DOCUMENT*.md`, `PROJECT.md`, `CHANGELOG.md`
- Entry points follow the language convention; a project may have several - Entry points follow the language convention; a project may have several
- The dependency/build directory (`.venv/`, `target/`, …) is tool-managed — do not copy it, do not generate it by hand - The dependency/build directory (`.venv/`, `target/`, …) is tool-managed — do not copy it, do not generate it by hand
@@ -65,8 +68,9 @@ Where this file and a design document disagree, **the design document wins**.
- `.gitignore` must cover at least: the dependency/build directory, tool caches, and `.env` - `.gitignore` must cover at least: the dependency/build directory, tool caches, and `.env`
- **Commit the lock file for applications, do not commit it for libraries** - **Commit the lock file for applications, do not commit it for libraries**
- **Never commit shared documentation** (`AGENTS.md`, `DESIGN_DOCUMENT*.md`) — it comes from the documentation repository, not from the project - **Every core document is committed**, including the shared ones (`CLAUDE.md`, `AGENTS.md`, `DESIGN_DOCUMENT*.md`). A checkout then carries the rules that applied to that code, and a fresh clone works standalone.
- `README.md`, `PROJECT.md` and `CHANGELOG.md` **are committed** — they are project-specific - **Never edit a shared document inside a project** — it is a copy. Changes belong in the documentation repository and are copied outward; project-specific deviations go in `PROJECT.md`.
- Synchronising the copies is its own commit (`docs: sync guidelines to AGENTS v8 / DESIGN_DOCUMENT_PYTHON v11`) and is **not** recorded in the project `CHANGELOG.md` — it is not a change to the product
### Commit messages ### Commit messages
CLAUDE.md
+2 -2
View File
@@ -1,6 +1,6 @@
# CLAUDE.md # CLAUDE.md
**Document Version:** v2 (independent, incremented on structural changes) **Document Version:** v3 (independent, incremented on structural changes)
## First-time setup ## First-time setup
@@ -11,4 +11,4 @@
- `AGENTS.md` - `AGENTS.md`
- `PROJECT.md` - `PROJECT.md`
- `CHANGELOG.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` — one per language used in the project (`DESIGN_DOCUMENT_PYTHON.md`, `DESIGN_DOCUMENT_PYTHON_MODULE.md`, `DESIGN_DOCUMENT_RUST.md`, `DESIGN_DOCUMENT_RUST_LIB.md`, `DESIGN_DOCUMENT_GODOT.md`)
DESIGN_DOCUMENT_MODULE.md → DESIGN_DOCUMENT_PYTHON_MODULE.md
+2 -2
View File
@@ -1,6 +1,6 @@
# Python Library Development Guidelines # Python Library Development Guidelines
**Document Version:** v2 **Document Version:** v4
> **Note on Versioning:** > **Note on Versioning:**
> - This document version is independent — reused across projects > - 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. 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_PYTHON_MODULE.md`, `PROJECT.md`, `CHANGELOG.md`.
--- ---