14 lines
565 B
Markdown
14 lines
565 B
Markdown
|
This is the directory for release note fragments processed by
|
||
|
|
[towncrier](https://github.com/hawkowl/towncrier).
|
||
|
|
|
||
|
|
When making a user-visible change create a file in this directory and it will be automatically be
|
||
|
|
included into the release note document when the next release is published.
|
||
|
|
|
||
|
|
The file extension specifies the type of a change. The following are currently supported:
|
||
|
|
|
||
|
|
- .feature: a new feature.
|
||
|
|
- .bugfix: a bug fix.
|
||
|
|
- .security: a fix for security issue.
|
||
|
|
- .doc: a documentation improvement.
|
||
|
|
- .removal: a deprecation or removal of functionality.
|