Skip to content

Commit 433e077

Browse files
committed
docs: Add AGENTS.md and review-feedback tip
1 parent 90075ee commit 433e077

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# AGENTS.md
2+
3+
Guidance for AI coding agents working in this repository.
4+
5+
See [CONTRIBUTING.md](./CONTRIBUTING.md) for everything you need, in particular:
6+
7+
- [Submitting a patch](./CONTRIBUTING.md#submitting-a-patch) - workflow and the scripts to run before submitting (`script/fmt.sh`, `script/test.sh`, `script/lint.sh`, `script/generate.sh`).
8+
- [Tips](./CONTRIBUTING.md#tips) - expectations for (AI-driven) PRs.
9+
- [Code Guidelines](./CONTRIBUTING.md#code-guidelines) - file organization, naming conventions, type conventions, JSON tags, pagination, generated code, and testing patterns.

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,9 @@ tips (which are frequently ignored by AI-driven PRs):
150150
fail, but with the included PR changes, the new test(s) pass.
151151
* When possible, try to make smaller, focused PRs (which are easier to review
152152
and easier for others to understand).
153+
* When a reviewer leaves a comment on one occurrence of an issue, apply the
154+
same fix to all similar occurrences throughout the entire PR - don't wait
155+
for the reviewer to point out each one individually.
153156

154157
## Code Guidelines
155158

0 commit comments

Comments
 (0)