From df0c205052e03155e44282ae6148e8e3b8390625 Mon Sep 17 00:00:00 2001 From: Povilas Kanapickas Date: Sun, 10 Jan 2021 19:47:24 +0200 Subject: [PATCH] doc: Setup towncrier for handling of release notes --- README.md | 6 +++++- doc/newsfragments/README.md | 12 ++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 doc/newsfragments/README.md diff --git a/README.md b/README.md index 830fcd7c..0b81d6f0 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,11 @@ For short and simple questions or to just say hello find us on the Freenode IRC ### Contributions -At this time we are looking for developers to help fix the issues found in the issue tracker. Submit pull requests once you've polished up your patch and we'll review and possibly merge it. +At this time we are looking for developers to help fix the issues found in the issue tracker. +Submit pull requests once you've polished up your patch and we'll review and possibly merge it. + +Most pull requests will need to include a release note. +See docs/newsfragments/README.md for documentation of how to do that. ## Distro specific packages diff --git a/doc/newsfragments/README.md b/doc/newsfragments/README.md new file mode 100644 index 00000000..a0ce3f33 --- /dev/null +++ b/doc/newsfragments/README.md @@ -0,0 +1,12 @@ +This is the directory for news snippets used by towncrier: https://github.com/twisted/towncrier + +When changing code in a way that's visible to an end user please make a new file in this directory. +It will be removed and integrated into release notes document upon a release of a new version of +Barrier. + +towncrier has a few standard types of news fragments, signified by the file extension. These are: + +.feature: Signifying a new feature. +.bugfix: Signifying a bug fix. +.doc: Signifying a documentation improvement. +.removal: Signifying a deprecation or removal of public API.