Skip to content

Commit 0a4fe42

Browse files
fabien-martygithub-actions[bot]claude
authored
docs: update AI agent guidelines (Human label, find-and-open args, PR/issue templates) (#46)
* docs: fix inaccurate ValueError claim for oversized values in set() docstrings Made-with: Cursor * docs: update AGENTS.md and cursor skills/commands for Human label and improved PR/issue templates Made-with: Cursor * revert: restore Python file changes already committed in another PR Co-authored-by: Fabien MARTY <fabien-marty@users.noreply.github.com> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com> Co-authored-by: Fabien MARTY <fabien-marty@users.noreply.github.com> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 8754429 commit 0a4fe42

4 files changed

Lines changed: 55 additions & 27 deletions

File tree

.cursor/commands/issues/find-and-open.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,43 @@ Thoroughly review the ENTIRE codebase to identify bugs, improvements, architectu
66

77
**This command is read-only: DO NOT modify any source file, test, config, or documentation.**
88

9+
## Arguments (`$ARGUMENTS`)
10+
11+
Parse the optional `$ARGUMENTS` string for the following keywords (case-insensitive). Multiple keywords can be combined.
12+
13+
| Keyword | Effect |
14+
|----------|--------|
15+
| `medium` | Do **not** open GitHub issues for `Priority: Low` findings — only display them in the summary output. |
16+
| `high` | Do **not** open GitHub issues for `Priority: Medium` or `Priority: Low` findings — only display them in the summary output. |
17+
| `local` | Do **not** open any GitHub issue at all — only display all findings in the summary output. |
18+
| `bug` | Only open GitHub issues for bug findings (those that would receive the `Type: Fixed` label); all other findings are only displayed in the summary output. |
19+
20+
When multiple keywords are present, apply all matching rules (most restrictive wins for priority filters).
21+
922
## Steps
1023

1124
1. **Read `AGENTS.md`** to understand the project conventions and constraints.
1225

13-
2. **Search existing github issues** to know what has already been reported. Avoid creating duplicate tasks.
26+
2. **Parse `$ARGUMENTS`** and determine which findings will be opened as GitHub issues vs. only displayed (see Arguments table above).
27+
28+
3. **Search existing github issues** to know what has already been reported. Avoid creating duplicate tasks.
1429

15-
3. **Review the entire codebase systematically.** Read all source files, tests, configuration files, and documentation.
30+
4. **Review the entire codebase systematically.** Read all source files, tests, configuration files, and documentation.
1631

17-
4. **For each issue found**, create a GitHub issue with:
18-
- A clear, specific **title**
19-
- A **description** explaining the issue, where it is (file + approximate location), why it matters, and a suggestion for fixing it
20-
- **Label**: `Reporter: AI` + `Type: ...` + `Priority: ...` (never add a `Status: ...` label when creating an issue)
32+
5. **For each issue found**, decide based on the parsed arguments whether to:
33+
- **Create** a GitHub issue with:
34+
- A clear, specific **title**
35+
- A **description** explaining the issue, where it is (file + approximate location), why it matters, and a suggestion for fixing it
36+
- **Label**: `Reporter: AI` + `Type: ...` + `Priority: ...` (never add a `Status: ...` label when creating an issue)
37+
- **Or only display** it in the summary output (no GitHub issue created).
2138

22-
5. **At the end**, display a summary table of all tasks created, grouped by label, showing task ID and title.
39+
6. **At the end**, display a summary table of all findings grouped by label, showing task ID (or `` if not created) and title, with a note indicating which were opened vs. display-only.
2340

2441
## Important rules
2542

2643
- **DO NOT modify any file in the repository.** This command is purely analytical.
2744
- **DO NOT create duplicate tasks.** Always check the existing GitHub issues before creating a new task.
2845
- **Be specific.** Each task should address one concrete, actionable issue — not vague observations.
29-
- **Be honest.** Only report genuine issues, not stylistic nitpicks that conflict with the project's established conventions
46+
- **Be honest.** Only report genuine issues, not stylistic nitpicks that conflict with the project's established conventions.
3047
- **Group related micro-issues.** If you find multiple typos in the same file or closely related minor issues, group them into a single task rather than creating many tiny tasks.
3148
- **It's OK if you don't find any issue!** In that case, just display a message "No issue found".

.cursor/skills/manage-github-issues/SKILL.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Use the `gh` command line tool for all GitHub issue operations. When creating is
1414
| List issues | `gh issue list` |
1515
| List open issues | `gh issue list --state open` |
1616
| View issue | `gh issue view <number>` |
17-
| Create issue | `gh issue create --title "..." --body "..." --label "ai"` |
17+
| Create issue | `gh issue create --title "..." --body "..." --label "Reporter: AI"` |
1818
| Edit issue | `gh issue edit <number> --title "..." --body "..."` |
1919
| Close issue | `gh issue close <number>` |
2020

@@ -66,8 +66,9 @@ gh label create "Priority: High" --color "e4181b" --description "High prior
6666
gh label create "Priority: Medium" --color "fbca04" --description "Medium priority"
6767
gh label create "Priority: Low" --color "c5def5" --description "Low priority"
6868

69-
# Reporter label
69+
# Reporter / workflow labels
7070
gh label create "Reporter: AI" --color "d4c5f9" --description "Created by AI agent"
71+
gh label create "Human" --color "fbca04" --description "Requires human intervention"
7172

7273
# Status labels
7374
gh label create "Status: Validated" --color "99d708" --description "Validated and ready to plan/implement"
@@ -136,6 +137,7 @@ gh issue list --limit 20
136137
We use the following standardized labels:
137138

138139
- `Reporter: AI` - Issues created by AI agents
140+
- `Human` - Issues that require human intervention (AI agents should skip these)
139141

140142
- `Status: Validated` - Issues that have been validated and that are ready to be planned/implemented
141143
- `Status: Planning` - Issues that are being worked on in planning mode

.cursor/skills/manage-github-pull-requests/SKILL.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,17 @@ Use the `gh` command line tool for all GitHub pull request operations.
2525
When creating or editing PRs, use this template for the body:
2626

2727
```markdown
28-
## Description
28+
## Summary
2929

30-
[Describe the changes in 1–3 paragraphs. Reference linked issues with Fixes #123 or Closes #123.]
30+
[1–3 bullet points describing what this PR does and why]
3131

32-
## Checklist
32+
## Changes
3333

34-
- [ ] Tests pass (`make test`)
35-
- [ ] Linting passes (`make lint`)
36-
- [ ] Documentation generated (`make doc`)
34+
[Brief list of the key files / components changed and why]
35+
36+
## Related issues
37+
38+
Closes #<issue-number> ← remove if no related issue
3739
```
3840

3941
## Creating PRs
@@ -42,29 +44,35 @@ When creating or editing PRs, use this template for the body:
4244

4345
```bash
4446
gh pr create --title "Title here" --body-file - << 'EOF'
45-
## Description
47+
## Summary
48+
49+
- Fix cache eviction bug when TTL expires
4650
47-
Description text. Fixes #42.
51+
## Changes
4852
49-
## Checklist
53+
- `atomic_lru/cache.py`: corrected eviction logic
54+
- `tests/test_cache.py`: added regression test
5055
51-
- [ ] Tests pass (`make test`)
52-
- [ ] Linting passes (`make lint`)
53-
- [ ] Documentation generated (`make doc`)
56+
## Related issues
57+
58+
Closes #42
5459
EOF
5560
```
5661

5762
**Inline body**:
5863

5964
```bash
60-
gh pr create --title "Title" --body "## Description
65+
gh pr create --title "Title" --body "## Summary
66+
67+
- Short description of what this PR does
68+
69+
## Changes
6170
62-
Description text.
71+
- List of key changes
6372
64-
## Checklist
73+
## Related issues
6574
66-
- [ ] Tests pass (\`make test\`)
67-
- [ ] Linting passes (\`make lint\`)" --label "Type: Fixed"
75+
Closes #42" --label "Type: Fixed"
6876
```
6977

7078
**Autofill from commits**:

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ We use the following standardized labels.
3333
### For issues only
3434

3535
- `Reporter: AI` - Issues created by AI agents
36+
- `Human` - Issues that require human intervention (AI agents should skip these)
3637

3738
- `Status: Validated` - Issues that have been validated and that are ready to be planned/implemented
3839
- `Status: Planning` - Issues that are being worked on in planning mode

0 commit comments

Comments
 (0)