-
Notifications
You must be signed in to change notification settings - Fork 61
feat(#1727): add bare-word grep pattern guidance for rename PRs #2044
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,3 +18,21 @@ references to renamed/removed identifiers. | |
| Extract identifiers from the diff, then search documentation files for | ||
| references. Flag docs that reference identifiers modified or removed in | ||
| this PR. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [low] design-direction The new Rename/deprecation pattern strategy section is appended to docs-currency.md but is not referenced by docs-review/SKILL.md step 4, where the grep script is constructed. The sub-agent will still see the guidance since it reads its full prompt, so the integration gap is minor. Suggested fix: Consider adding a cross-reference to the pattern strategy section in docs-review/SKILL.md step 4. |
||
|
|
||
| ## Rename/deprecation pattern strategy | ||
|
|
||
|
rh-hemartin marked this conversation as resolved.
|
||
| When a PR renames or removes an identifier (config key, CLI flag, API | ||
| field, function name, etc.), search for stale references using **both** | ||
| broad and syntax-specific grep patterns: | ||
|
|
||
| 1. **Bare-word pattern** (`\bOLD_NAME\b`) — catches all mentions | ||
| including prose, comments, backtick-wrapped references, and code. | ||
| Run this first and evaluate hits in context. | ||
| 2. **Syntax-specific pattern** (e.g., `OLD_NAME:` for YAML keys, | ||
| `--OLD_NAME` for CLI flags) — catches structured usage in config | ||
| and code files. | ||
|
|
||
| Documentation files (`.md`, `.adoc`, `.rst`) frequently reference field | ||
| names in prose without syntax-specific suffixes (e.g., "set the | ||
| `repository` field"). Always include the bare-word pattern when scanning | ||
| these file types — a syntax-specific pattern alone will miss them. | ||
Uh oh!
There was an error while loading. Please reload this page.