|
2 | 2 |
|
3 | 3 | ## Submitter Guidelines
|
4 | 4 |
|
5 |
| -- Title the PR using customer-focused language. The release notes are generated from PR titles, so the titles should |
| 5 | +- Title the PR using customer-focused language. The automatic release notes are generated from PR titles, so the titles should |
6 | 6 | describe the feature from the user's perspective and avoid implementation details. For example, instead of "Add debug
|
7 |
| - boolean", write "Support configurable debug mode". |
| 7 | + boolean", write "Support configurable debug mode". If the PR introduces a change that affects users and needs to be mentioned |
| 8 | + in the curated [release notes](../CHANGELOG.md), add a brief note that summarizes the change in the `release-note` block |
| 9 | + in the PR description. |
8 | 10 | - Fill in [our pull request template](/.github/PULL_REQUEST_TEMPLATE.md).
|
9 | 11 | - Make sure to include the issue number in the PR description to automatically close the issue when the PR mergers.
|
10 | 12 | See [Closing Issues via Pull Requests](https://github.blog/2013-05-14-closing-issues-via-pull-requests/) for details.
|
|
28 | 30 | guidelines to follow:
|
29 | 31 | - Commit each code review change individually.
|
30 | 32 | - Use descriptive commit messages that accurately describe the change made, making it easy for the reviewer to
|
31 |
| - understand the purpose of the change. |
| 33 | + understand the purpose of the change. |
32 | 34 | - When approved, and all review comments have been resolved; squash commits to a single commit. Follow
|
33 | 35 | the [Commit Message Format](#commit-message-format) guidelines when writing the final commit.
|
34 | 36 |
|
|
47 | 49 | - Have internal workflow and informational docs been impacted?
|
48 | 50 | - Are there unit tests for the change?
|
49 | 51 | - If the change is a bug fix, has a unit test been added or modified that catches the bug? All bug fixes should
|
50 |
| - be reproduced with a unit test before submitting any code. Then the code should be fixed so that the unit test |
51 |
| - passes. |
| 52 | + be reproduced with a unit test before submitting any code. Then the code should be fixed so that the unit test |
| 53 | + passes. |
52 | 54 | - If the change is a feature or new functionality. The expectation is to include a reasonable set of unit tests
|
53 |
| - which exercise positive and negative cases. |
| 55 | + which exercise positive and negative cases. |
54 | 56 | - Is this change backwards compatible? Is it causing breaking behavior?
|
55 | 57 | - Are there any [Comment Tags](#comment-tags) in the change?
|
56 | 58 |
|
|
0 commit comments