Skip to content

Commit b643d0f

Browse files
authored
docs: clarify technical issue requirements (#2226)
1 parent a4e6805 commit b643d0f

2 files changed

Lines changed: 6 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ task procedures only when needed:
1515
| Adding or changing a CLI flag | `docs/agents/cli-flags.md` |
1616
| Opening or reviewing a PR | `docs/agents/pull-requests.md` |
1717
| Running against a real device | `docs/agents/device-verification.md` |
18-
| Issues, PRDs, and triage labels | `docs/agents/issue-tracker.md`, `docs/agents/triage-labels.md` |
18+
| Writing issues or PRDs, and triage labels | `docs/agents/issue-tracker.md`, `docs/agents/triage-labels.md` |
1919
| Web backend setup or diagnostics | `docs/agents/web-backend.md` |
2020

2121
Versioned CLI help is the source of truth for command behavior. Start workflow planning with

docs/agents/issue-tracker.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ External PRs are not part of the triage request queue. Use `gh pr` commands only
1010

1111
## Conventions
1212

13+
Write issues as concise implementation contracts. Start with the purpose. Include a concrete API,
14+
data shape, or CLI example when the issue changes a boundary. State required behavior, observable
15+
completion conditions, and dependencies. Use plain, direct sentences. Remove persuasion, repeated
16+
context, and filler, but never remove a normative requirement to make the issue shorter.
17+
1318
`gh` authentication may only be available through the user's login shell. In sandboxed agent environments, run GitHub operations through the login shell and request escalation for network/auth access, for example:
1419

1520
```sh

0 commit comments

Comments
 (0)