19 lines
1.4 KiB
Markdown
19 lines
1.4 KiB
Markdown
# Project Context & Rules
|
|
|
|
## Language Specification
|
|
- **Project Docs:** All documents generated or updated under `Doc/`, project root Markdown documentation MUST be written in Chinese.
|
|
- **Codebase:** Source code syntax (class names, function names, variables, file names, API identifiers, route identifiers) must remain in English, but all code comments, documentation (Docstrings), and commit messages MUST be written in Chinese.
|
|
|
|
## Agent / Sub-agent Enforcement
|
|
- **Mandatory pre-read:** Any agent/sub-agent that generates or updates files MUST read this file (`CONTEXT.md`) first and follow it as the source-of-truth for language/style constraints.
|
|
- **Chinese-only outputs:** Any artifact written under `Doc/` MUST be Chinese. Do not output English headings/sections unless the content is a literal code identifier or a proper noun that should not be translated.
|
|
- **When spawning sub-agents:** The orchestrator MUST either:
|
|
- set `fork_context=true`, AND
|
|
- explicitly instruct the agent to read `CONTEXT.md` before writing; OR
|
|
- (if `fork_context=false`) explicitly include the above constraints in the sub-agent prompt and still require a `CONTEXT.md` pre-read.
|
|
|
|
### Recommended prompt snippet (copy into sub-agent tasks)
|
|
1) First read `CONTEXT.md` and follow all rules.
|
|
2) All markdown you write under `Doc/` MUST be Chinese.
|
|
3) Keep code identifiers / file paths / commands in English as-is.
|