Skip to content
New issue

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

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

Already on GitHub? # to your account

please add a ChangeLog - and possibly include the change notes when tagging #1138

Closed
GitMensch opened this issue Feb 25, 2022 · 3 comments
Closed

Comments

@GitMensch
Copy link

The main thing I've found so far was the 1.0 status update note, otherwise only the git log.

To be able to quickly check what changed in earlier/current/upcoming versions a ChangeLog.MD would be most useful - for some notices why this is useful for repos even when there's a git log and with suggestions how to format / what to include there I suggest to have a look at https://keepachangelog.com .

When keeping an "unreleased" part and adding to it, there's also a nice summary that can be used during tagging - making the tag/release information also much more useful.

As an initial version there are a bunch of npm tools available that I didn't try but they may help if the information isn't "somewhere else" (like announcements) already.

@mscdex
Copy link
Owner

mscdex commented Feb 25, 2022

As someone who single-handedly maintains several projects in their free time (which isn't much these days), about the only time I have for non-coding tasks like that is when there are major/breaking changes that people need to know about. On top of that, those kinds of changes are not very frequent for my projects, so it's a reasonable tradeoff.

These days I do try to publish releases frequently to get fixes in the hands of users, but I can't be bothered to write changelog entries for all of these quick changes for all of my projects. About the only thing I could provide would be a changelog containing git commits and messages (since this could be automated), like node.js core does, but that's not very useful as someone can obtain that same information from git and/or the github web interface.

@billchurch
Copy link

Love all you're doing and appreciate your work. Something you may want to consider, which could be lightweight in the sense of maintenance, would be to adopt Standard Version. This generates changelogs dynamically based on commit messages. It doesn't need a lot of change to your workflow and could help to accommodate what's being asked for.

@mscdex
Copy link
Owner

mscdex commented Dec 11, 2023

Closing this for the reasons I previously mentioned.

@mscdex mscdex closed this as completed Dec 11, 2023
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

No branches or pull requests

3 participants