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

Add a CHANGELOG.md #102

Open
aszlig opened this issue Dec 21, 2019 · 4 comments
Open

Add a CHANGELOG.md #102

aszlig opened this issue Dec 21, 2019 · 4 comments

Comments

@aszlig
Copy link

aszlig commented Dec 21, 2019

It's very hard to figure out what has changed between cms_pico versions, given that there isn't even a summary of changes in the GitHub release notes, nor is there a dedicated CHANGELOG.md.

Can you please provide a CHANGELOG.md as documented in the Nextcloud developer documentation, so that not only people who find the repository see what's changed but they're actually shown in the app update UI.

Thank you in advance.

@republicus
Copy link

Update today, and i have no idea what's improved

@PhrozenByte
Copy link
Collaborator

See v1.0.5...v1.0.6. Help with writing a CHANGELOG.md is very appreciated 👍

@aszlig
Copy link
Author

aszlig commented May 15, 2020

Already wrote the changelog in aszlig/avonc@29bd512, but since I do this for every single app from the app store lacking a changelog, I tend to avoid doing in-depth analysis of the changes for apps I'm not using (this one is one of them).

Since b9981fd is the actual relevant part of the changes (apart from dep/i18n updates), it's pretty difficult to write a proper changelog, since the commit message is lacking a reason why the commit was done. This essentially makes the author of the commit the only person knowing the information and I'm not quite sure how anyone else could be able to help with this.

As mentioned, I'm used to `git diff`` and guessing the author's thoughts for commits from a lot of Nextcloud apps on a daily basis and since the situation probably won't improve a lot, I'd love to help writing the Changelog since I'm going to do it anyway post-release...

However, the question is:

See v1.0.5...v1.0.6. Help with writing a CHANGELOG.md is very appreciated 👍

What exactly does this mean?

Like help with what exactly? Summarising the commits for every release in a changelog? Just creating the boilerplate for Keep a Changelog?

@PhrozenByte
Copy link
Collaborator

PhrozenByte commented May 15, 2020

I actually tend to write commit messages that pretty much sum up what and why something was changed. In this case it's actually no more than "various small changes", changes that don't really matter, they don't cause any issues right now, but might do in the future and are just "more correct" 🙈

Besides the l10n updates there's de65cde that is pretty important. Since Pico CMS for Nextcloud is basically a "management app" for Pico, all changes made to Pico are relevant to Pico CMS for Nextcloud, too. Pico has a CHANGELOG.md (even though Pico v2.1.2 doesn't have any significant changes either).

So, why was v1.0.6 released? No particular reason. I was working on Pico CMS for Nextcloud and there were just enough changes in the pipeline (especially l10n updates) which were worth creating a new release, so I did 😅 There's no release schedule.

What exactly does this mean?

Following development, being able to to assess why something was changed and extracting the necessary information to write a CHANGELOG.md. Basically taking responsibility to do it - not just for a single time, but also in the future.

Writing a CHANGELOG.md is a lot of work since it's more than just listing commit messages. There has to be an advantage over looking at the commit history. My time unfortunately is very limited and I have to make decisions what to do with the free time I have - and I just reckon that more people would want me to see working on new features (#99) than writing a CHANGELOG.md.

So, as I said, help is very appreciated! ❤️ Not just with writing a CHANGELOG.md, with improving Pico CMS for Nextcloud in general; this wouldn't even require working on Pico CMS for Nextcloud itself, like improving Nextcloud's text app to finally be compatible with us would be amazing.

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

No branches or pull requests

3 participants