feat: build in organized-feedback validation script and update docs
This commit is contained in:
@@ -3,3 +3,5 @@ refs/ 里有 gitea API 的 spec
|
|||||||
版本号规则:
|
版本号规则:
|
||||||
- 当前输出文档版本号固定为 `v1`
|
- 当前输出文档版本号固定为 `v1`
|
||||||
- 如果用户没有明确要求 bump 版本号,禁止修改版本号
|
- 如果用户没有明确要求 bump 版本号,禁止修改版本号
|
||||||
|
|
||||||
|
默认在工作到合适的时候就自己进行提交即可.
|
||||||
|
|||||||
@@ -27,14 +27,14 @@ Use this skill to turn a single PR review document into organized feedback.
|
|||||||
## RFC Subfields
|
## RFC Subfields
|
||||||
When a review item is classified as `request-for-change`, annotate it with:
|
When a review item is classified as `request-for-change`, annotate it with:
|
||||||
- `Change-Scope`: how broad the requested change is.
|
- `Change-Scope`: how broad the requested change is.
|
||||||
- `local`
|
- `local`: Small, local edits that can usually be finished quickly (for example: rename identifiers, syntax sugar swap, blank-line/order cleanup, light module structure cleanup).
|
||||||
- `implement`
|
- `implement`: Implementation-flow changes that affect business logic behavior (for example: sync points, transaction handling, feature implementation strategy). These typically need tests that demonstrate why the old behavior is insufficient.
|
||||||
- `api-change`
|
- `api-change`: API contract changes for widely used internal interfaces or external interfaces. These usually require updating dependent tests and call sites.
|
||||||
- `requirement-change`
|
- `requirement-change`: Requirement-level correction where the solved requirement itself is considered unreasonable and must be re-evaluated.
|
||||||
- `Necessity`: how strongly the change is required.
|
- `Necessity`: how strongly the change is required.
|
||||||
- `nice-to-have`
|
- `nice-to-have`: Optional improvement after higher-priority requests are resolved (for example: vague polish suggestions, minor wrappers/helpers).
|
||||||
- `should-fix`
|
- `should-fix`: Should be fixed unless there is a defensible reason to defer (for example: proven not triggerable, known low impact, or deferred to next PR with explicit note).
|
||||||
- `must-fix`
|
- `must-fix`: Mandatory blocker. The PR should not be merged until this is resolved.
|
||||||
|
|
||||||
## Processing Flow
|
## Processing Flow
|
||||||
1. Read the PR markdown and identify each review comment or feedback unit.
|
1. Read the PR markdown and identify each review comment or feedback unit.
|
||||||
@@ -81,3 +81,4 @@ Do not write the coverage audit into the final output file.
|
|||||||
- Preserve the user-specified output path.
|
- Preserve the user-specified output path.
|
||||||
- Keep the final file limited to the agreed format.
|
- Keep the final file limited to the agreed format.
|
||||||
- Do not add extra audit notes, scratch work, or intermediate classification logs to the final file.
|
- Do not add extra audit notes, scratch work, or intermediate classification logs to the final file.
|
||||||
|
- If terminal access is available, run `bash skills/organized-feedback/scripts/validate_organized_feedback_skill.sh` after updating this skill to verify contract and example integrity.
|
||||||
|
|||||||
+11
-11
@@ -2,10 +2,10 @@
|
|||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||||
REPO_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
|
SKILL_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
|
||||||
SKILL_FILE="$REPO_ROOT/skills/organized-feedback/SKILL.md"
|
SKILL_FILE="$SKILL_ROOT/SKILL.md"
|
||||||
INPUT_EXAMPLE="$REPO_ROOT/skills/organized-feedback/examples/input-pr-review.md"
|
INPUT_EXAMPLE="$SKILL_ROOT/examples/input-pr-review.md"
|
||||||
OUTPUT_EXAMPLE="$REPO_ROOT/skills/organized-feedback/examples/output-organized-feedback.md"
|
OUTPUT_EXAMPLE="$SKILL_ROOT/examples/output-organized-feedback.md"
|
||||||
|
|
||||||
if ! command -v rg >/dev/null 2>&1; then
|
if ! command -v rg >/dev/null 2>&1; then
|
||||||
echo "FAIL: rg is required but was not found in PATH"
|
echo "FAIL: rg is required but was not found in PATH"
|
||||||
@@ -35,14 +35,14 @@ anchored_patterns=(
|
|||||||
'^## Final File Format$'
|
'^## Final File Format$'
|
||||||
'^## Output Discipline$'
|
'^## Output Discipline$'
|
||||||
'^- `Change-Scope`: how broad the requested change is\.$'
|
'^- `Change-Scope`: how broad the requested change is\.$'
|
||||||
'^ - `local`$'
|
'^ - `local`: .+$'
|
||||||
'^ - `implement`$'
|
'^ - `implement`: .+$'
|
||||||
'^ - `api-change`$'
|
'^ - `api-change`: .+$'
|
||||||
'^ - `requirement-change`$'
|
'^ - `requirement-change`: .+$'
|
||||||
'^- `Necessity`: how strongly the change is required\.$'
|
'^- `Necessity`: how strongly the change is required\.$'
|
||||||
'^ - `nice-to-have`$'
|
'^ - `nice-to-have`: .+$'
|
||||||
'^ - `should-fix`$'
|
'^ - `should-fix`: .+$'
|
||||||
'^ - `must-fix`$'
|
'^ - `must-fix`: .+$'
|
||||||
'^- `All-Source-Refs`: every source reference found in the interaction$'
|
'^- `All-Source-Refs`: every source reference found in the interaction$'
|
||||||
'^- `Covered-Source-Refs`: refs that are represented in the organized output$'
|
'^- `Covered-Source-Refs`: refs that are represented in the organized output$'
|
||||||
'^- `Missing-Source-Refs`: refs that are present in the interaction but not yet covered$'
|
'^- `Missing-Source-Refs`: refs that are present in the interaction but not yet covered$'
|
||||||
Reference in New Issue
Block a user