1# Pending release notes directory
2
3This directory contains release note entries that have not been merged
4into the main release-notes.md document.
5
6Generally 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
12Release 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
20Release notes are included in files under this `docs/release-notes.d`
21directory 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
23entry.  (A script will be developed to collect these, ordered by when
24the commits were added to the tree.)
25
26Choose a filename that is related to what this change does.  The names
27are not used for anything in particular, but to keep the files
28distinct so that there isn't a concern with merge conflicts as
29different pull requests merge in different orders.
30