mirror of
https://github.com/google/go-github.git
synced 2026-10-28 16:34:37 +08:00
docs: Add AGENTS.md and review-feedback tip (#4368)
This commit is contained in:
1 parent
395561136f
commit
73fcc12791
2 files changed
+12
No files matched your search
@@ -0,0 +1,9 @@
|
||||
# AGENTS.md
|
||||
|
||||
Guidance for AI coding agents working in this repository.
|
||||
|
||||
See [CONTRIBUTING.md](./CONTRIBUTING.md) for everything you need, in particular:
|
||||
|
||||
- [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`).
|
||||
- [Tips](./CONTRIBUTING.md#tips) - expectations for (AI-driven) PRs.
|
||||
- [Code Guidelines](./CONTRIBUTING.md#code-guidelines) - file organization, naming conventions, type conventions, JSON tags, pagination, generated code, and testing patterns.
|
||||
@@ -150,6 +150,9 @@ tips (which are frequently ignored by AI-driven PRs):
|
||||
fail, but with the included PR changes, the new test(s) pass.
|
||||
* When possible, try to make smaller, focused PRs (which are easier to review
|
||||
and easier for others to understand).
|
||||
* When a reviewer leaves a comment on one occurrence of an issue, apply the
|
||||
same fix to all similar occurrences throughout the entire PR - don't wait
|
||||
for the reviewer to point out each one individually.
|
||||
|
||||
## Code Guidelines
|
||||
|
||||
|
||||
Reference in new issue
Block a user