refactor(prompts): qualify style rule citations
This commit is contained in:
@@ -27,7 +27,7 @@ Use this format for each finding:
|
|||||||
`code-path:line`
|
`code-path:line`
|
||||||
> `smallest reviewed-code excerpt that shows the violation`
|
> `smallest reviewed-code excerpt that shows the violation`
|
||||||
|
|
||||||
`rule-file:line`: Finding title.
|
`skill::rule-file:line`: Finding title.
|
||||||
Summary: why the code breaks the rule
|
Summary: why the code breaks the rule
|
||||||
Fix: suggested fix
|
Fix: suggested fix
|
||||||
```
|
```
|
||||||
@@ -35,7 +35,7 @@ Fix: suggested fix
|
|||||||
Keep the code excerpt to one to three lines when possible.
|
Keep the code excerpt to one to three lines when possible.
|
||||||
Use a longer excerpt only when the violation needs surrounding context.
|
Use a longer excerpt only when the violation needs surrounding context.
|
||||||
Use `...` to omit unrelated lines from a multi-line excerpt.
|
Use `...` to omit unrelated lines from a multi-line excerpt.
|
||||||
Use a skill-relative rule citation, such as `tests.md:7`.
|
Use a style-skill rule citation, such as `rust::files.md:23` or `nix::let.md:7`.
|
||||||
Make the fix direct.
|
Make the fix direct.
|
||||||
Do not include alternatives when one fix best follows the cited rule.
|
Do not include alternatives when one fix best follows the cited rule.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user