|
3 | 3 | This documentation augments the general documentation for contributing to the
|
4 | 4 | x/tools repository, described at the [repository root](../../CONTRIBUTING.md).
|
5 | 5 |
|
6 |
| -Contributions are welcome, but since development is so active, we request that |
7 |
| -you file an issue and claim it before starting to work on something. Otherwise, |
8 |
| -it is likely that we might already be working on a fix for your issue. |
| 6 | +Contributions are welcome! However, development is fast moving, |
| 7 | +and we are limited in our capacity to review contributions. |
| 8 | +So, before sending a CL, please please please: |
| 9 | + |
| 10 | +- **file an issue** for a bug or feature request, if one does not |
| 11 | + exist already. This allows us to identify redundant requests, or to |
| 12 | + merge a specific problem into a more general one, and to assess the |
| 13 | + importance of the problem. |
| 14 | + |
| 15 | +- **claim it for yourself** by commenting on the issue or, if you are |
| 16 | + able, by assigning the issue to yourself. This helps us avoid two |
| 17 | + people working on the same problem. |
| 18 | + |
| 19 | +- **propose an implementation plan** in the issue tracker for CLs of |
| 20 | + any complexity. It is much more efficient to discuss the plan at a |
| 21 | + high level before we start getting bogged down in the details of |
| 22 | + a code review. |
| 23 | + |
| 24 | +When you send a CL, it should include: |
| 25 | + |
| 26 | +- a **CL description** that summarizes the change, |
| 27 | + motivates why it is necessary, |
| 28 | + explains it at a high level, |
| 29 | + contrasts it with more obvious or simpler approaches, and |
| 30 | + links to relevant issues; |
| 31 | +- **tests** (integration tests or marker tests); |
| 32 | +- **documentation**, for new or modified features; and |
| 33 | +- **release notes**, for new features or significant changes. |
| 34 | + |
| 35 | +During code review, please address all reviewer comments. |
| 36 | +Some comments result in straightforward code changes; |
| 37 | +others demand a more complex response. |
| 38 | +When a reviewer asks a question, the best response is |
| 39 | +often not to respond to it directly, but to change the |
| 40 | +code to avoid raising the question, |
| 41 | +for example by making the code self-explanatory. |
| 42 | +It's fine to disagree with a comment, |
| 43 | +point out a reviewer's mistake, |
| 44 | +or offer to address a comment in a follow-up change, |
| 45 | +leaving a TODO comment in the current CL. |
| 46 | +But please don't dismiss or quietly ignore a comment without action, |
| 47 | +as it may lead reviewers to repeat themselves, |
| 48 | +or to serious problems being neglected. |
| 49 | + |
| 50 | +For more detail, see the Go project's |
| 51 | +[contribution guidelines](https://golang.org/doc/contribute.html). |
9 | 52 |
|
10 | 53 | ## Finding issues
|
11 | 54 |
|
|
0 commit comments