Skip to content

Commit fd0155d

Browse files
committed
Add release-note section in PR template (nginx#1574)
Problem: Writing release notes at release time takes a long time and it's not easy to do if you don't have as much context as the submitter or simply too much time has passed. Solution: Add a release notes section to be filled out when opening a PR. This way at release time we can just grab all the descriptions and speed up the process.
1 parent c762d94 commit fd0155d

File tree

2 files changed

+19
-6
lines changed

2 files changed

+19
-6
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,14 @@ Before creating a PR, run through this checklist and mark each as complete.
2525
- [ ] I have updated necessary documentation
2626
- [ ] I have rebased my branch onto main
2727
- [ ] I will ensure my PR is targeting the main branch and pulling from my branch from my own fork
28+
29+
### Release notes
30+
31+
If this PR introduces a change that affects users and needs to be mentioned in the [release notes](../CHANGELOG.md),
32+
please add a brief note that summarizes the change.
33+
34+
<!-- If this PR does not require a release note, you can just write NONE in the release-note block below. -->
35+
36+
```release-note
37+
38+
```

docs/developer/pull-request.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22

33
## Submitter Guidelines
44

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
66
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.
810
- Fill in [our pull request template](/.github/PULL_REQUEST_TEMPLATE.md).
911
- Make sure to include the issue number in the PR description to automatically close the issue when the PR mergers.
1012
See [Closing Issues via Pull Requests](https://github.blog/2013-05-14-closing-issues-via-pull-requests/) for details.
@@ -28,7 +30,7 @@
2830
guidelines to follow:
2931
- Commit each code review change individually.
3032
- 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.
3234
- When approved, and all review comments have been resolved; squash commits to a single commit. Follow
3335
the [Commit Message Format](#commit-message-format) guidelines when writing the final commit.
3436

@@ -47,10 +49,10 @@
4749
- Have internal workflow and informational docs been impacted?
4850
- Are there unit tests for the change?
4951
- 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.
5254
- 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.
5456
- Is this change backwards compatible? Is it causing breaking behavior?
5557
- Are there any [Comment Tags](#comment-tags) in the change?
5658

0 commit comments

Comments
 (0)