Skip to content

Commit 30e098f

Browse files
skjnldsvclaude
andcommitted
chore: add issue-fixing workflow rules to AGENTS.md
Read existing content, check cross-references, grep for related occurrences, verify build before marking done. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
1 parent 81c80ef commit 30e098f

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,21 @@ redirects = {
7070
Never edit files under `locale/`. Managed by Transifex, synced via CI.
7171
Source strings live in `.rst` files only.
7272

73+
## Working on existing issues
74+
75+
Before editing any page:
76+
1. **Read the full page first** — never patch blind; understand existing context, structure, and tone
77+
2. **Search for related content** — same topic may appear in multiple manuals or sections; check all of them for consistency
78+
3. **Check cross-references** — search for `:doc:` and `:ref:` links pointing to the page; related pages may need updating too
79+
4. **Grep for the affected term/feature** across the repo — docs often repeat concepts in different contexts
80+
81+
```bash
82+
grep -r "feature_name" user_manual/ admin_manual/ developer_manual/ --include="*.rst" -l
83+
```
84+
85+
5. **Verify the fix builds** — run `sphinx-lint` on edited files and `make html` on the affected manual before marking done
86+
6. **One issue, one PR** — don't fix unrelated problems noticed along the way; open separate issues instead
87+
7388
## Branch strategy
7489

7590
- `master` = latest (currently NC34)

0 commit comments

Comments
 (0)