File tree Expand file tree Collapse file tree 2 files changed +35
-0
lines changed Expand file tree Collapse file tree 2 files changed +35
-0
lines changed Original file line number Diff line number Diff line change 1+ # Pending release notes directory
2+
3+ This directory contains release note entries that have not been merged
4+ into the main release-notes.md document.
5+
6+ Generally a release note entry should be created for changes that:
7+
8+ - Fix bugs in the code.
9+ - Implement new features.
10+ - Change existing behavior.
11+
12+ Release notes are generally not needed for:
13+
14+ - Some documentation improvements.
15+ - Strictly internal changes to the code that won't be visible to users
16+ of the code.
17+
18+ ## Release note format
19+
20+ Release notes are included in files under this ` docs/release-notes.d `
21+ directory and have a name of ` *.md ` . They will be included in the
22+ ` release-notes.md ` file, and should be formatted as a Markdown list
23+ entry. (A script will be developed to collect these, ordered by when
24+ the commits were added to the tree.)
25+
26+ Choose a filename that is related to what this change does. The names
27+ are not used for anything in particular, but to keep the files
28+ distinct so that there isn't a concern with merge conflicts as
29+ different pull requests merge in different orders.
Original file line number Diff line number Diff line change @@ -24,6 +24,12 @@ Before making a release, update the `docs/release-notes.md` file
2424to describe the release. This should be a high-level description of
2525the changes, not a list of the git commits.
2626
27+ Provided that changes going into the release have followed the
28+ contribution guidelines, this should mostly consist of collecting the
29+ various snippets in the ` docs/release-notes.d ` directory. After
30+ incorporating these snippets into the release notes, the snippet files
31+ should be removed to ready the directory for the next release cycle.
32+
2733## Release candidates
2834
2935Before each release, tags are made (see below) for at least one
You can’t perform that action at this time.
0 commit comments