search

kergoth / beets-stylize

Beets plugin to add style to your music library.
MIT License
2 stars 0 forks source link

Decide on a release notes / changelog scheme and follow it #12

Open kergoth opened 3 weeks ago

kergoth commented 3 weeks ago

The cookie cutter template I used assumes the use of release drafter, which assumes release notes generated solely by pull requests. This is too limited, in my opinion, especially for a personal project where not all changes will be through PRs. Instead, there are two viable options:

  1. Changelog generation from commits, which assumes Conventional Commits or the like.
  2. Keep a Changelog, which requires diligence in the manual maintenance of the changelog, and integration of its contents into the GitHub release process.
kergoth commented 3 weeks ago

I lean more toward the latter, given how many commits make non-user-visible changes. I've also worked on projects using conventional commits, and find that folks often lump commits all into a single category, like chore, even if this isn't the most appropriate section for a given change. There's too much overhead in stopping to determine the category, I think.