Skip to content

Commit 4e76f07

Browse files
committed
Add development conventions doc for naming and path standards
1 parent 4e2671a commit 4e76f07

2 files changed

Lines changed: 38 additions & 0 deletions

File tree

docs/dev/dev_conventions.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Development Conventions
2+
3+
This file defines baseline development conventions for Chronos Engine.
4+
5+
## Naming Convention
6+
7+
- Use `lower_snake_case` for new directories, files, modules, and commands.
8+
- Use lowercase folder names under `user/` for canonical item/data paths.
9+
- Use lowercase command IDs and command filenames.
10+
11+
Examples:
12+
- `user/tasks/`
13+
- `user/schedules/`
14+
- `modules/scheduler/`
15+
- `commands/quickwins.py`
16+
17+
## Path Convention
18+
19+
- Prefer forward-slash canonical paths in docs and code comments: `user/settings/config.yml`.
20+
- Windows-style paths are fine in runtime handling when required, but canonical references should still map to lowercase `user/<dir>` paths.
21+
- Avoid introducing new uppercase path variants (for example `user/Tasks`).
22+
23+
## Scope Boundary
24+
25+
- Chronos Engine conventions apply to this repo’s main engine and docs.
26+
- `Agents Dress Up Committee/` may maintain its own naming conventions unless explicitly standardized.
27+
28+
## Contributions Checklist
29+
30+
Before merging changes:
31+
32+
1. Confirm new file/folder names follow `lower_snake_case`.
33+
2. Confirm all new `user/...` path references use normalized lowercase directory names.
34+
3. Run:
35+
- `python scripts/check_docs_drift.py`
36+
- targeted/regression tests as appropriate.
37+

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ This index points to the main documentation entry points in this repo and what e
3232

3333
## Development
3434
- Architecture: `docs/dev/architecture.md` - runtime modules and data flow.
35+
- Development Conventions: `docs/dev/dev_conventions.md` - naming, path, and contribution standards (`lower_snake_case`).
3536
- Extensibility: `docs/dev/extensibility.md` - dynamic registries (Wizards, Themes, Data Cards).
3637
- Data Cards: `docs/dev/data_cards.md` - generic item schema and backend details.
3738
- Sequence Mirrors: `docs/dev/sequence.md` - SQLite mirrors and trends pipeline.

0 commit comments

Comments
 (0)