| 1 |
This is the directory for release note fragments processed by |
| 2 |
[towncrier](https://github.com/hawkowl/towncrier). |
| 3 |
|
| 4 |
When making a user-visible change create a file in this directory and it will be automatically be |
| 5 |
included into the release note document when the next release is published. |
| 6 |
|
| 7 |
The file extension specifies the type of a change. The following are currently supported: |
| 8 |
|
| 9 |
- .feature: a new feature. |
| 10 |
- .bugfix: a bug fix. |
| 11 |
- .security: a fix for security issue. |
| 12 |
- .doc: a documentation improvement. |
| 13 |
- .removal: a deprecation or removal of functionality. |