返回 ppt-master
README.md
根目录 / docs / rules / README.md
1 # Project Rules
2
3 Conventions and style guides for contributors and AI agents working in this repository. These rules are derived from the de facto patterns in existing code and reference documents.
4
5 | Rule | Scope |
6 |---|---|
7 | [`prompt-style.md`](./prompt-style.md) | Style guide for files under `skills/ppt-master/references/` — voice, sectioning, table-first, forbidden patterns |
8 | [`code-style.md`](./code-style.md) | Style guide for Python under `skills/ppt-master/scripts/` — file headers, imports, CLI entry points, error handling, no-tests rule |
9
10 When adding a new rule file:
11
12 - One topic per file
13 - File name `<topic>.md` (lowercase, hyphenated)
14 - Add a row to the table above
15 - The body should be **prescriptive, not descriptive** — tell readers what to do, not what the project happens to look like
16
16 lines MARKDOWN