README.md
1This is the directory for release note fragments processed by
2[towncrier](https://github.com/twisted/towncrier).
3
4When making a user-visible change create a file in this directory and it will be automatically be
5included into the release note document when the next release is published.
6
7The file extension specifies the type of a change. The following are currently supported:
8
9 - .backend: a new feature or a bugfix for a backend.
10 - .frontend: a new feature or a bugfix for a frontend.
11 - .security: a fix for security issue.
12 - .removal: a deprecation or removal of functionality.
13 - .misc: miscellaneous changes
14
15Please don't add links to the merge requests into the release notes. If it's not clear where
16the feature is coming from by looking into the git history (e.g. if a release note is being
17made after the MR has landed) then add link to the MR to the commit description.
18
19Please add links to fixed issues in Gitlab by using full URLs to them instead of Gitlab
20shorthand syntax.
21