Skip to content

Commit 4337fee

Browse files
committed
docs: Describe the release note snippet requirement
Add mention of the release note requirements to the SubmittingPatches file so that developers are more likely to see and comply. Signed-off-by: David Brown <david.brown@linaro.org>
1 parent d4184eb commit 4337fee

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/SubmittingPatches.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,20 @@ Certificate of Origin" located at the bottom of this page:
3030
see this [link]
3131
(https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
3232

33+
## Release notes
34+
35+
To facilitate creating release notes at release time, all non-trivial
36+
changes must include a release note snippet in the pull request.
37+
This can be either a separate commit, or as part of a single commit
38+
(generally, if there are multiple commits to the pull request, the
39+
release note snippet should be a separate commit, and a pull request
40+
that is a single commit can include the release note snippet in that
41+
commit). In either case, the release notes must be included in the
42+
same PR that makes the given change.
43+
44+
The release notes should be placed in the `docs/release-notes.d`
45+
directory. Please see the readme file in that directory for specifics.
46+
3347
## Developer certificate of origin
3448

3549
The following is the "Developer Certificate of Origin":

0 commit comments

Comments
 (0)