Developers:

Friend to friend: When you make a release please take a few minutes to make a human-readable changelog of what has changed since the last release?

Your commit-messages are not a changelog.

Let me re-iterate:

Your commit-messages are _not_ a changelog.

A changelog allows me to follow what you were thinking between releases.

A commit log shows me your keystrokes between releases.

I need to know what you were thinking.

Thank you.

@craigmaloney Obviously everyone will agree with that. That's not the issue. The issue is how to make writing release notes more practical.

@fortuna Sure. it begins by pausing for a moment and reflecting on what the release contains. Making the pause happen is the hard part since developers don't tend to want to pause. Until we get that pause and the moment of reflection there's no practical way to make it better.

Follow

@craigmaloney I believe that works well for single-person or small project but it's challenging when you need to scale to many changes and collaborators.

In that case release notes will scale better if you maintain running notes, updated when important changes happen by the authors themselves.

Sign in to participate in the conversation
Mastodon

Fast, secure and up-to-date instance, welcoming everyone around the world. Join us! 🌍
Up since 04/04/2017. ✅

Why should you sign up on mstdn.io?

This instance is not focused on any theme or subject, feel free to talk about whatever you want. Although the main language is english, we accept every single language and country.

We're connected to the whole ActivityPub fediverse and we do not block any foreign instance nor user.

We do have rules, but the goal is to have responsible users.

The instance uses a powerful server to ensure speed and stability, and it has good uptime. We follow state-of-the-art security practices.

Also, we have over 300 custom emojis to unleash your meming potential!


Looking for a Kpop themed instance? Try kpop.social