loki icon indicating copy to clipboard operation
loki copied to clipboard

Maintain a CHANGELOG.md

Open missing1984 opened this issue 4 years ago • 2 comments

First of all, kudos on this awesome project, we love it and would like to invest more time in making it better.

One low-hanging fruit is to add a CHANGELOG.md so people can understand what features/bugfixes they get by upgrading to the latest version.

Depends on how do we want to implement the dev workflow, we can either do it manually or uses https://www.conventionalcommits.org/en/v1.0.0/

missing1984 avatar Dec 08 '20 02:12 missing1984

Hi, I try to do that in the github releases instead. Do you think that's a good approach or does a separate changelog file has other advantages? Example: https://github.com/oblador/loki/releases/tag/v0.28.0

oblador avatar Feb 09 '21 09:02 oblador

Sorry for the late reply.. github release works but i think have changelog be part of the source code is still nice to have as

  • People can see all changes in one file and search for the changes they're interested.
  • Most of popular projecst maintain a CHANGELOG.md. It's by default the first place people look for changelog.. at least for me.

It's definitely not a blocker and urgent :)

missing1984 avatar May 05 '21 19:05 missing1984