diff options
Diffstat (limited to 'doc/newsfragments')
| -rw-r--r-- | doc/newsfragments/README.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/newsfragments/README.md b/doc/newsfragments/README.md new file mode 100644 index 0000000..0338cf8 --- /dev/null +++ b/doc/newsfragments/README.md @@ -0,0 +1,13 @@ +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. |