mirror of
https://github.com/clash-verge-rev/clash-verge-rev.git
synced 2026-11-18 18:02:08 +08:00
chore(docs): centralize issue guidance and trim PR descriptions
This commit is contained in:
@@ -1,3 +1,29 @@
|
||||
<!--
|
||||
Describe the final problem, approach, and evidence needed to review this change.
|
||||
When updating the body, replace stale text instead of appending implementation
|
||||
history or review-round summaries.
|
||||
|
||||
State each fact once. Omit details already clear from the diff unless they
|
||||
explain a non-obvious constraint or trade-off. Describe concrete behavior instead
|
||||
of self-evaluation or unsupported assurances such as "more robust" or "seamless".
|
||||
Mention unchanged behavior or excluded areas only when they matter to review.
|
||||
Before publishing, remove any sentence whose deletion loses no information
|
||||
needed to understand the problem, approach, evidence, or material limitations.
|
||||
|
||||
Omit file-by-file diff summaries, internal planning scores, agent handoffs, and
|
||||
routine check results such as "Clippy passed", "lint passed", or "local tests
|
||||
passed". Do not add a Validation/Testing section for a command checklist.
|
||||
Include concrete before/after behavior or measurements when they support the
|
||||
change, and retain limitations that affect review. Link reviewer-accessible
|
||||
details when needed; do not paste full scripts, logs, or test matrices into the
|
||||
body, including collapsed sections.
|
||||
|
||||
Keep Scope only when explaining necessary changes outside the core fix, PR
|
||||
dependencies, or why added tests are needed. Do not repeat Approach there.
|
||||
For small changes, Problem and Approach may be combined into one short paragraph;
|
||||
remove unnecessary headings instead of adding text to fill them.
|
||||
-->
|
||||
|
||||
## Problem
|
||||
|
||||
What breaks or what is missing. Product bug fixes and features require a
|
||||
@@ -14,4 +40,6 @@ Why this change solves the problem — the reasoning behind the approach, not a
|
||||
|
||||
## Scope
|
||||
|
||||
What changed. If anything outside the core fix was touched, explain why it was necessary. New tests are not expected by default — if any were added, justify why each is needed.
|
||||
Optional: explain necessary changes outside the core fix, PR dependencies, or
|
||||
why added tests are needed. Otherwise remove this section. New tests are not
|
||||
expected by default.
|
||||
|
||||
Reference in New Issue
Block a user