diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 01d96cbb5..81ea47f03 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,9 +61,9 @@ Otherwise fork the repository and create a branch in your fork. Please add a meaningful description to your PR so that reviewers get an idea about what the modifications are supposed to do. -A meaningful PR title is helpful for [updating `CHANGELOG.md` on releases](./RELEASE.md) -(CHANGELOG.md is updated manually -to only add things that are at least roughly understandable by the end user) +If the PR is about end-user-related enhancements or fixes, +add an understandable, not too technical, +line atop of [`CHANGELOG.md`](./CHANGELOG.md) under the title `## Unreleased` If the changes affect the user interface, screenshots are very helpful, diff --git a/RELEASE.md b/RELEASE.md index 95d7717ea..bbd27da89 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -20,18 +20,15 @@ the "update-core-and-stuff-DATE" PR can be merged without review then, create a "bump-to-VERSION" PR: -3. a) update CHANGELOG.md - from - and . - do not just copy and avoid technical terms. - the changelog is for the end user and shall show impacts form that angle. - for consistency, use existing formatting style. - b) update changelog date as `YYYY-MM` - c) add used core version to end of changelog entry - as `update to core 1.2.3` or `using core 1.2.3` - - in case previous entries of the changelog refer to betas or to not officially released versions, - the entries can be summarized. +3. update CHANGELOG.md: + a) add title `## v1.2.3` or `## v1.2.3 Testflight` + b) redact lines from `## Unreleased` there + c) add core version to end of changelog entry as `- update to core 1.2.3` or `- using core 1.2.3` + c) encorperate + and redact too technical terms, so that the end user can understand it + + in case previous entries of the changelog refer to not officially released versions, + the entries should be summarized. this makes it easier for the end user to follow changes by showing major changes atop. 4. on major changes, add a device message to `ChatListController::viewDidLoad()`