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.

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

Can a changelog file be added? #391

Open
laurasalisbury opened this issue Oct 1, 2024 · 2 comments
Open

Can a changelog file be added? #391

laurasalisbury opened this issue Oct 1, 2024 · 2 comments

Comments

@laurasalisbury
Copy link

To understand the evolution of the app's releases.

@thunderbiscuit
Copy link
Owner

thunderbiscuit commented Oct 1, 2024

It's funny because I had a changelog all the way up to version 0.12.0 I think and for some reason I decided to take it out? (commit 1e70287).

I think the issue with it was that I was using it as a traditional changelog for libraries (Added/Changed/Breaking/Removed), but also for UI and user-facing changes, and then it all just got mixed up and really it wasn't useful for either use cases.

I think it's worth reintroducing, however with some better-defined purpose. Here is what I propose (feel free to comment on this or not):

  1. The changelog(s) be focused on user-facing changes. This is basically the changelog from the point of view of someone downloading the app on the Play Store. New features, deprecated features, UI upgrades/changes, etc.
  2. I think for this to work well, we should carry two changelogs, one for each app, because the two will have very different changes for each release, and I don't intend to keep them in perfect sync or anything like that. This means I would put the changelogs in Android/CHANGELOG.md and iOS/CHANGELOG.md.

@laurasalisbury
Copy link
Author

ok, sounds good!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants