search

Bouni / python-luxtronik

python-luxtronik is a library that allow you to interact with a Luxtronik heatpump controller.
MIT License
37 stars 19 forks source link

Introduce and maintain a changelog #135

Open kbabioch opened 1 year ago

kbabioch commented 1 year ago

We should introduce and maintain a changelog that is meant to be read by users of this library. It should focus on notable changes (new features, etc.).

A good example is "Keep a Changelog", which is described in more detail here.

I don't think it is worthwhile to create it retroactively for previous releases, but with a upcoming new (major) release we should start to use it and keep the notable changes prepared in an Unreleased section and have a good description as part of (bigger) pull requests.

Bouni commented 1 year ago

I totally agree with this! I've read somewhere that there's kind of a workflow to make it easier by prefix PRs with [feature], [bug] and so on which then can be parsed by an GH action to lower the hurdle keeping the Changelog up to date. Unfortunately I don't recall where I've seen that 😅

Bouni commented 1 year ago

@kbabioch I searched but didn't find the article I've read in the past. But I stumbled up on Git Cliff I guess something like that is the way to go. For sure we then have to stick with conventional commits but that can also be enforced with a GH action via commitlint as well as a pre-commit-hook I guess