🎨 style(markdown): format markdown files with prettier

This commit is contained in:
csh 2026-01-07 15:30:18 +08:00
parent 41fc43b79e
commit 3b2188f336
6 changed files with 3625 additions and 1344 deletions

View File

@ -16,22 +16,25 @@ Turn a user prompt into a **single, actionable plan** delivered in the final ass
Throughout the entire workflow, operate in read-only mode. Do not write or update files.
1. **Scan context quickly**
- Read `README.md` and any obvious docs (`docs/`, `CONTRIBUTING.md`, `ARCHITECTURE.md`).
- Skim relevant files (the ones most likely touched).
- Identify constraints (language, frameworks, CI/test commands, deployment shape).
2. **Ask follow-ups only if blocking**
- Ask **at most 12 questions**.
- Only ask if you cannot responsibly plan without the answer; prefer multiple-choice.
- If unsure but not blocked, make a reasonable assumption and proceed.
3. **Create a plan using the template below**
- Start with **1 short paragraph** describing the intent and approach.
- Clearly call out what is **in scope** and what is **not in scope** in short.
- Then provide a **small checklist** of action items (default 610 items).
- Each checklist item should be a concrete action and, when helpful, mention files/commands.
- **Make items atomic and ordered**: discovery → changes → tests → rollout.
- **Verb-first**: “Add…”, “Refactor…”, “Verify…”, “Ship…”.
- Each checklist item should be a concrete action and, when helpful, mention files/commands.
- **Make items atomic and ordered**: discovery → changes → tests → rollout.
- **Verb-first**: “Add…”, “Refactor…”, “Verify…”, “Ship…”.
- Include at least one item for **tests/validation** and one for **edge cases/risk** when applicable.
- If there are unknowns, include a tiny **Open questions** section (max 3).
@ -45,10 +48,12 @@ Throughout the entire workflow, operate in read-only mode. Do not write or updat
<13 sentences: what were doing, why, and the high-level approach.>
## Scope
- In:
- Out:
## Action items
[ ] <Step 1>
[ ] <Step 2>
[ ] <Step 3>
@ -57,18 +62,22 @@ Throughout the entire workflow, operate in read-only mode. Do not write or updat
[ ] <Step 6>
## Open questions
- <Question 1>
- <Question 2>
- <Question 3>
```
## Checklist item guidance
Good checklist items:
- Point to likely files/modules: src/..., app/..., services/...
- Name concrete validation: “Run npm test”, “Add unit tests for X”
- Include safe rollout when relevant: feature flag, migration plan, rollback note
Avoid:
- Vague steps (“handle backend”, “do auth”)
- Too many micro-steps
- Writing code snippets (keep the plan implementation-agnostic)

View File

@ -11,7 +11,7 @@
- TSL 源文件后缀同时包含:`.tsl`(脚本)与 `.tsf`(模块/库代码)。
- 代码风格:`tsl/code_style.md`
- 命名规范:`tsl/naming.md`
- 语法手册TSL语法`function.md` 建议按需检索):`tsl/syntax_book/index.md`
- 语法手册TSL 语法;`function.md` 建议按需检索):`tsl/syntax_book/index.md`
- 工具链与验证命令(模板):`tsl/toolchain.md`
## C++cpp

View File

@ -192,6 +192,7 @@ end;
function RenderParagraph(para_: {DocxML.}Paragraph): void;
```
- 无返回值函数显式标注返回类型为 `void``create`/`destroy` 作为构造/析构函数不写返回类型。
```tsl

View File

@ -105,7 +105,7 @@
- [MTOC](#mtoc-1)
- [MTOC(TICK:double)获得与某个指定的 TICK 之间的秒数](#mtoctickdouble获得与某个指定的-tick-之间的秒数)
- [**line**](#line)
- [\_\_stack\_frame](#__stack_frame)
- [\_\_stack_frame](#__stack_frame)
- [面向对象支持的保留字](#面向对象支持的保留字)
- [内容](#内容-8)
- [TYPE](#type)

File diff suppressed because it is too large Load Diff

View File

@ -31,4 +31,3 @@ git commit -m ":memo: docs(ci): add standards check workflow"
- `docs/common/commit_message.md`
- `docs/standards/playbook/docs/common/commit_message.md`
- 默认要求 emoji如需允许无 emoji在 workflow 中设置 `COMMIT_LINT_REQUIRE_EMOJI=0`