Skip to content

Commit f43d2cf

Browse files
authored
docs: Update CONTRIBUTING.md to prevent AI slop PRs (#3940)
1 parent 096e4ce commit f43d2cf

1 file changed

Lines changed: 20 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,25 @@ file.
9090
[monitored by codecov.io]: https://codecov.io/gh/google/go-github
9191
[REVIEWERS]: ./REVIEWERS
9292

93+
## Tips
94+
95+
Although we have not (yet) banned AI-driven contributions to this repo (as many
96+
other open source projects have), we encourage you to read and honor the following
97+
tips (which are frequently ignored by AI-driven PRs):
98+
99+
* Always review your own PRs using the same user interface that your actual
100+
reviewers will be using with a critical eye, attempting to anticipate what your
101+
reviewers will call out, _before_ asking anyone to review your PR.
102+
* Come up with a short and appropriate PR title.
103+
* Come up with a short, well-written, and appropriate PR description (we don't
104+
need hundreds of lines of text here - keep it short and to-the-point so a
105+
reviewer can _quickly_ determine what the PR is all about).
106+
* If a PR involves bug fixes, it should certainly include a unit test (or tests)
107+
that demonstrates the bug - without the PR changes, the new unit test would
108+
fail, but with the included PR changes, the new test(s) pass.
109+
* When possible, try to make smaller, focused PRs (which are easier to review
110+
and easier for others to understand).
111+
93112
## Code Comments
94113

95114
Every exported method and type needs to have code comments that follow
@@ -178,7 +197,7 @@ may be useful to know what it is. Its sections are:
178197
the OpenAPI descriptions. Others have no documentation_url and result in a
179198
note in the generated code that the documentation is missing.
180199

181-
- `operation_overrides` - is where we override the documentation_url for
200+
- `operation_overrides` - is where we override the documentation_url for
182201
operations where the link in the OpenAPI descriptions is wrong.
183202

184203
Please note that if your PR unit tests are failing due to an out-of-date

0 commit comments

Comments
 (0)