feat: build in organized-feedback validation script and update docs
This commit is contained in:
@@ -27,14 +27,14 @@ Use this skill to turn a single PR review document into organized feedback.
|
||||
## RFC Subfields
|
||||
When a review item is classified as `request-for-change`, annotate it with:
|
||||
- `Change-Scope`: how broad the requested change is.
|
||||
- `local`
|
||||
- `implement`
|
||||
- `api-change`
|
||||
- `requirement-change`
|
||||
- `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`: 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 contract changes for widely used internal interfaces or external interfaces. These usually require updating dependent tests and call sites.
|
||||
- `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.
|
||||
- `nice-to-have`
|
||||
- `should-fix`
|
||||
- `must-fix`
|
||||
- `nice-to-have`: Optional improvement after higher-priority requests are resolved (for example: vague polish suggestions, minor wrappers/helpers).
|
||||
- `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`: Mandatory blocker. The PR should not be merged until this is resolved.
|
||||
|
||||
## Processing Flow
|
||||
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.
|
||||
- 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.
|
||||
- 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.
|
||||
|
||||
Reference in New Issue
Block a user