aboutsummaryrefslogtreecommitdiffstats
path: root/doc/newsfragments/README.md
blob: 0338cf80bfa64d1385022a5c14851fa66bb9069b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
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.