Skip to content

Commit ad2b00d

Browse files
authored
Merge pull request #2044 from fullsend-ai/agent/1727-broaden-stale-ref-grep
feat(#1727): add bare-word grep pattern guidance for rename PRs
2 parents 4a1ea86 + 9b3eff8 commit ad2b00d

3 files changed

Lines changed: 33 additions & 0 deletions

File tree

internal/scaffold/fullsend-repo/skills/code-review/SKILL.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,12 @@ readability or correctness.
184184
- Do documentation files reference behavior, APIs, or configurations
185185
changed by this PR?
186186
- Are any docs now stale as a result of the change?
187+
- **Rename/deprecation completeness:** When a PR renames or removes an
188+
identifier, grep for stale references using a bare-word pattern
189+
(`\bOLD_NAME\b`) in addition to any syntax-specific pattern (e.g.,
190+
`OLD_NAME:` for YAML). Documentation files (`.md`, `.adoc`, `.rst`)
191+
often reference field names in prose without syntax suffixes and will
192+
be missed by syntax-specific patterns alone.
187193

188194
#### Cross-repo contracts
189195

internal/scaffold/fullsend-repo/skills/docs-review/SKILL.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,15 @@ and exit — there is nothing to check.
9494

9595
Write a shell script that takes the identifiers from step 2 and
9696
greps for each one across the documentation files from step 3.
97+
98+
**Rename/deprecation PRs:** When a PR renames or removes an identifier,
99+
use a bare-word pattern (`\bOLD_NAME\b`) in addition to any
100+
syntax-specific pattern (e.g., `OLD_NAME:` for YAML). Documentation
101+
files often reference field names in prose without syntax suffixes and
102+
will be missed by syntax-specific patterns alone. See the
103+
`docs-currency` sub-agent's "Rename/deprecation pattern strategy"
104+
section for the full approach.
105+
97106
Run the script in a single Bash call:
98107

99108
```bash

internal/scaffold/fullsend-repo/skills/pr-review/sub-agents/docs-currency.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,21 @@ references to renamed/removed identifiers.
1818
Extract identifiers from the diff, then search documentation files for
1919
references. Flag docs that reference identifiers modified or removed in
2020
this PR.
21+
22+
## Rename/deprecation pattern strategy
23+
24+
When a PR renames or removes an identifier (config key, CLI flag, API
25+
field, function name, etc.), search for stale references using **both**
26+
broad and syntax-specific grep patterns:
27+
28+
1. **Bare-word pattern** (`\bOLD_NAME\b`) — catches all mentions
29+
including prose, comments, backtick-wrapped references, and code.
30+
Run this first and evaluate hits in context.
31+
2. **Syntax-specific pattern** (e.g., `OLD_NAME:` for YAML keys,
32+
`--OLD_NAME` for CLI flags) — catches structured usage in config
33+
and code files.
34+
35+
Documentation files (`.md`, `.adoc`, `.rst`) frequently reference field
36+
names in prose without syntax-specific suffixes (e.g., "set the
37+
`repository` field"). Always include the bare-word pattern when scanning
38+
these file types — a syntax-specific pattern alone will miss them.

0 commit comments

Comments
 (0)