From fcfe76042386be74a76a0bc62fa277f22de9abb1 Mon Sep 17 00:00:00 2001 From: Doug Date: Tue, 25 Jun 2024 11:04:50 +0100 Subject: [PATCH] Update changelog documentation. --- .github/PULL_REQUEST_TEMPLATE.md | 6 ++-- CONTRIBUTING.md | 50 +------------------------------- 2 files changed, 4 insertions(+), 52 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index cfdff383da..398b38d1fe 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,8 +1,8 @@ ### Pull Request Checklist -- [ ] I read the [contributing guide](https://github.com/element-hq/element-ios/blob/develop/CONTRIBUTING.md) -- [ ] Pull request contains a [changelog file](https://github.com/matrix-org/matrix-ios-sdk/blob/develop/CONTRIBUTING.md#changelog) in ./changelog.d -- [ ] Pull request includes a [sign off](https://github.com/matrix-org/matrix-ios-sdk/blob/develop/CONTRIBUTING.md#sign-off) +- [ ] I read the [contributing guide](https://github.com/element-hq/element-ios/blob/develop/CONTRIBUTING.md). +- [ ] Pull request contains a [changelog label](https://github.com/element-hq/element-x-ios/blob/develop/CONTRIBUTING.md#changelog). +- [ ] Pull request includes a [sign off](https://github.com/matrix-org/matrix-ios-sdk/blob/develop/CONTRIBUTING.md#sign-off). **UI changes have been tested with:** - [ ] iPhone and iPad simulators in portrait and landscape orientations. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 10da130657..2351726bab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,55 +99,7 @@ New screen flows are currently using the MVVM-Coordinator pattern. Please refer ## Changelog -All changes, even minor ones, need a corresponding changelog / newsfragment -entry. These are managed by [Towncrier](https://github.com/twisted/towncrier). - -To create a changelog entry, make a new file in the `changelog.d` directory -named in the format of `ElementXiOSIssueNumber.type`. The type can be one of the -following: - -- `feature` for a new feature -- `change` for updates to an existing feature -- `bugfix` for bug fix -- `api` for an api break -- `i18n` for translations -- `build` for changes related to build, tools, CI/CD -- `doc` for updates to the documentation -- `wip` for anything that isn't ready to ship and will be enabled at a later date -- `misc` for other changes - -This file will become part of our [changelog](CHANGES.md) at the next -release, so the content of the file should be a short description of your -change in the same style as the rest of the changelog. The file must only -contain one line. It can contain Markdown formatting. It should start with the -area of the change (screen, module, ...) and end with a full stop (.) or an -exclamation mark (!) for consistency. - -Adding credits to the changelog is encouraged, we value your -contributions and would like to have you shouted out in the release notes! - -For example, a fix for an issue #1234 would have its changelog entry in -`changelog.d/1234.bugfix`, and contain content like: - -> Voice Messages: Fix a crash when sending a voice message. Contributed by -> Jane Matrix. - -If there are multiple pull requests involved in a single bugfix/feature/etc, -then the content for each `changelog.d` file should be the same. Towncrier will -merge the matching files together into a single changelog entry when we come to -release. - -There are exceptions on the `ElementXiOSIssueNumber.type` entry format. Even if -it is not encouraged, you can use: - -- `pr-[PRNumber].type` for a PR with no related issue -- `x-nolink-[AnyNumber].type` for a PR with a change entry that will not have a link automatically appended. It must be used for internal project update only. `AnyNumber` should be a value that does not clash with existing files. - -To preview the changelog for pending changelog entries, use: - -```bash -$ towncrier build --draft --version 1.2.3 -``` +Our [changelog](CHANGES.md) is automatically generated by GitHub based on the PR title that you use when opening the issue. The changelog can be categorised by applying on of the [`pr-` labels](https://github.com/element-hq/element-x-ios/labels?q=pr-) to your PR. The mapping of Label → Section can be found in the [release.yml](.github/release.yml) file. The contribution will be automatically credited to your GitHub username. ## Coding style