| David Brown | d4184eb | 2023-02-14 16:52:24 -0700 | [diff] [blame] | 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. |