From 6240910b9063a91959ad694dfc337a1f4cf1aaee Mon Sep 17 00:00:00 2001 From: Benoit Marty Date: Thu, 20 May 2021 16:53:26 +0200 Subject: [PATCH] Configure towncrier tools - Update documentation --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CHANGES.md | 33 -------------------------------- CONTRIBUTING.md | 16 ++++++++++++++-- 3 files changed, 15 insertions(+), 36 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 34d7b40a88..501aa6784a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,6 +5,6 @@ - [ ] Changes has been tested on an Android device or Android emulator with API 21 - [ ] UI change has been tested on both light and dark themes - [ ] Pull request is based on the develop branch -- [ ] Pull request updates [CHANGES.md](https://github.com/vector-im/element-android/blob/develop/CHANGES.md) +- [ ] Pull request includes a new file under ./newsfragment. See https://github.com/vector-im/element-android/blob/develop/CONTRIBUTING.md#changelog - [ ] Pull request includes screenshots or videos if containing UI changes - [ ] Pull request includes a [sign off](https://github.com/matrix-org/synapse/blob/master/CONTRIBUTING.md#sign-off) diff --git a/CHANGES.md b/CHANGES.md index a28b84410e..97beae1dbe 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1379,36 +1379,3 @@ Changes in RiotX 0.1.0 (2019-07-11) First release! Mode details here: https://medium.com/@RiotChat/introducing-the-riotx-beta-for-android-b17952e8f771 - - -======================================================= -+ TEMPLATE WHEN PREPARING A NEW RELEASE + -======================================================= - - -Changes in Element 1.1.X (2021-XX-XX) -=================================================== - -Features ✨: - - - -Improvements 🙌: - - - -Bugfix 🐛: - - - -Translations 🗣: - - - -SDK API changes ⚠️: - - - -Build 🧱: - - - -Test: - - - -Other changes: - - diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dd32991051..399216ac4f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,9 +51,21 @@ If an issue does not exist yet, it may be relevant to open a new issue and let u This project is full Kotlin. Please do not write Java classes. -### CHANGES.md +### Changelog -Please add a line to the top of the file `CHANGES.md` describing your change. +Please create at least one file under ./newsfragment containing details about your change. Towncrier will be used when preparing the release. + +Towncrier says to use the PR number for the filename, but the issue number is also fine. + +Supported filename extensions are: + +- ``.feature``: Signifying a new feature in Element Android or in the Matrix SDK. +- ``.bugfix``: Signifying a bug fix. +- ``.doc``: Signifying a documentation improvement. +- ``.removal``: Signifying a deprecation or removal of public API. Can be used to notifying about API change in the Matrix SDK +- ``.misc``: A ticket has been closed, but it is not of interest to users. + +See https://github.com/twisted/towncrier#news-fragments if you need more details. ### Code quality