|
90 | 90 | [monitored by codecov.io]: https://codecov.io/gh/google/go-github |
91 | 91 | [REVIEWERS]: ./REVIEWERS |
92 | 92 |
|
| 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 | + |
93 | 112 | ## Code Comments |
94 | 113 |
|
95 | 114 | 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: |
178 | 197 | the OpenAPI descriptions. Others have no documentation_url and result in a |
179 | 198 | note in the generated code that the documentation is missing. |
180 | 199 |
|
181 | | -- `operation_overrides` - is where we override the documentation_url for |
| 200 | +- `operation_overrides` - is where we override the documentation_url for |
182 | 201 | operations where the link in the OpenAPI descriptions is wrong. |
183 | 202 |
|
184 | 203 | Please note that if your PR unit tests are failing due to an out-of-date |
|
0 commit comments