🎨 style(markdown): format markdown files with prettier
This commit is contained in:
parent
41fc43b79e
commit
3b2188f336
|
|
@ -16,16 +16,19 @@ 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 1–2 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 6–10 items).
|
||||
|
|
@ -45,10 +48,12 @@ Throughout the entire workflow, operate in read-only mode. Do not write or updat
|
|||
<1–3 sentences: what we’re 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)
|
||||
|
|
|
|||
|
|
@ -192,6 +192,7 @@ end;
|
|||
|
||||
function RenderParagraph(para_: {DocxML.}Paragraph): void;
|
||||
```
|
||||
|
||||
- 无返回值函数显式标注返回类型为 `void`;`create`/`destroy` 作为构造/析构函数不写返回类型。
|
||||
|
||||
```tsl
|
||||
|
|
|
|||
|
|
@ -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
|
|
@ -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`。
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue