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

Unify documentation rules across languages and fix the Python template

Browse Source 
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Jan Doubravský
2026-08-18 10:33:00 +02:00
co-authored by Claude Opus 5
parent 19e9b8f2fa
commit 5c0f2f758f
19 changed files with 502 additions and 244 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Godot/DESIGN_DOCUMENT_GODOT.md
+10 -7
View File
@@ -4,7 +4,7 @@
> **Note on Versioning:**
> - This document version is independent — reused across Godot projects
> - **Project version** source of truth: `project.godot` (`config/version`) mirrored in an autoload `Constants` script
> - **Project version** source of truth: `project.godot` (`application/config/version`) mirrored in an autoload `Constants` script
> - Version propagates: `project.godot` → `Constants.gd` → code
> - `CHANGELOG.md` uses the project version
@@ -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: `DESIGN_DOCUMENT_GODOT.md`, `AGENTS.md`, `PROJECT.md`, `CHANGELOG.md`.
The root directory contains only the core documents: `README.md`, `AGENTS.md`, `DESIGN_DOCUMENT_GODOT.md`, `PROJECT.md`, `CHANGELOG.md`.
---
@@ -213,16 +213,19 @@ When the game is distributed as a standalone build:
### Task notation
Tasks are written as single-line comments directly in code, or in `PROJECT.md` for cross-cutting concerns:
Tasks are written as single-line comments directly in code, using the **Todo Tree** tags defined in `AGENTS.md` (`TODO`, `FIXME`, `BUG`, `HACK`, `NOTE`). `PROJECT.md` carries only cross-cutting tasks that have no single place in the code.
```gdscript
# TODO: one-liner description of a task to be done
# FIXME: one-liner description of a known bug to be fixed
# TODO: move this into a reusable StateMachine scene
# FIXME: player clips through the floor at high speed
# BUG: hitbox stays active one frame too long
# HACK: temporary yield until the animation signal is wired up
# NOTE: must run in _physics_process, not _process
```
No other task format is used — no checkboxes, no numbered lists in documentation.
No other task format is used — **no checkboxes, no numbered lists in documentation**.
If a `# TODO:` comment already exists at a specific location in code, do not repeat it in `PROJECT.md`.
If a tag already exists at a specific location in code, do not repeat it in `PROJECT.md`.
---