Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

bureaucracy: PRs should have a CHANGELOG entry #2386

Merged
merged 2 commits into from
Nov 5, 2024
Merged

bureaucracy: PRs should have a CHANGELOG entry #2386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b1fa14
bureaucracy: PRs should have a CHANGELOG entry
r10s Nov 5, 2024
b08d759
Update RELEASE.md
r10s Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
21 changes: 9 additions & 12 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/deltachat/deltachat-core-rust/blob/main/CHANGELOG.md>
and <https://github.com/deltachat/deltachat-ios/pulls?q=is%3Apr+is%3Aclosed+sort%3Aupdated-desc>.
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`
zeitschlag marked this conversation as resolved.
Show resolved Hide resolved
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) incorporate <https://github.com/deltachat/deltachat-core-rust/blob/main/CHANGELOG.md>
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()`
Expand Down
Loading