Update CHANGELOG.md #86
Conversation
Version 4.0.0-beta.1 changelog update
| * Remove unnecessary keyboard tracking. by @michaelkirk in https://github.com/maplibre/maplibre-navigation-ios/pull/69 | ||
| * Fix crash in EndOfRouteViewController and restore its presentation by @michaelkirk in https://github.com/maplibre/maplibre-navigation-ios/pull/71 | ||
| * Fix retain cycles in RouteMapViewController by @michaelkirk in https://github.com/maplibre/maplibre-navigation-ios/pull/74 | ||
| * Add "Build Example Project" to CI by @michaelkirk in https://github.com/maplibre/maplibre-navigation-ios/pull/77 |
There was a problem hiding this comment.
I'm personally in favor of having the changelog only include entries which are relevant to users. If they want every single PR they can look at Github, otherwise the important stuff just gets lost in the "tweaked the CI script" and "fixed tests". That work is important too, but it makes the changelog less useful to users.
(There are some inarguably useful ones added here - mostly ones that I forgot to add 😞)
There was a problem hiding this comment.
I don't feel super strongly about this btw, if people want to include every single PR in the changelog, I will choose another hill to die on. 😆
There was a problem hiding this comment.
Yeah, I agree, a changelog should contain changes 👍
There was a problem hiding this comment.
I have no strong feelings about this either. My thoughts:
- Who decides what is truly important and what isn't? Everything is a change, and someone who has had broken tests for months may be super excited about that specific change
- More exposure for everyone who does a PR
- It's much easier than manual change log maintenance: github generates this format at a click of the button, including links to the auther and the specific pr, while in the other case, we've had so many PRs that need to go through an additional "review loop" because someone forgot to update the changelog with their change, delaying progress, often by days or weeks - and the manual entries have no links to the pr, meaning if you ever are interested in details, you'll have to dig a bit.
You're welcome to dismiss this PR though if the manual changelog maintenance is preferred.
There was a problem hiding this comment.
I don't have any strong feelings about this either, all good, just wanted to mention my opinion :)
There was a problem hiding this comment.
I guess I should add my opinion and maybe we can come to a resolution :)
Core principles:
- Make processes EASY so you don't have to think about them as either a contributor or maintainer
- A changelog should inform users of what changed
Application:
- Putting every PR in the changelog is an easy action (add a checklist to the PR template and/or CI checks)
- A pure listing is technically informative, but it's not the best organization IMO.
- Solution: Add headings that group PRs. Something like enhancement, deprecation, removal, and bug fix, along with notes about any breaking changes. Valhalla does a pretty good job at most of these, for example.
|
Closing the PR as the community prefers manually curated change logs 😊 |
Updating changelog for the 4.0.0 beta release.