Added changelog file.

[intelfisz]

No description provided.

[codecov]

Codecov Report

Merging #167 (8b585a1) into main (875e957) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #167   +/-   ##
=======================================
  Coverage   98.65%   98.65%           
=======================================
  Files           4        4           
  Lines         372      372           
=======================================
  Hits          367      367           
  Misses          4        4           
  Partials        1        1           

[intelfisz]

Under review - please do not merge yet

[glimchb]

Under review - please do not merge yet

@intelfisz you can mark PRs as draft if not ready to merge

[glimchb]

I don't know if this is the best approach...
because github auto-creates changelog for you when you create a release...
example https://github.com/opiproject/opi-spdk-bridge/releases
but it can be formatted as you like...

[intelfisz]

@glimchb - thanks for the hint but...
I want to have a clean and meaningful backlog and not just a listing from git log - BTW this is an anti-pattern, see https://keepachangelog.com/en/1.1.0/#bad-practices.

[glimchb]

@glimchb - thanks for the hint but... I want to have a clean and meaningful backlog and not just a listing from git log - BTW this is an anti-pattern, see https://keepachangelog.com/en/1.1.0/#bad-practices.

make sense. but when you create a release you can clean up the change log as you wish and format it...

another option is use changelog.md file and then when you create github release, give the changelog file to github to use...

anyways I want to avoid have 2 different things in 2 places...

you can experiment on your private fork of the repo to see what works for you...

[intelfisz]

@glimchb - thanks for the hint but... I want to have a clean and meaningful backlog and not just a listing from git log - BTW this is an anti-pattern, see https://keepachangelog.com/en/1.1.0/#bad-practices.

make sense. but when you create a release you can clean up the change log as you wish and format it...

another option is use changelog.md file and then when you create github release, give the changelog file to github to use...

anyways I want to avoid have 2 different things in 2 places...

you can experiment on your private fork of the repo to see what works for you...

yes, we don't want to maintain same thing in 2 places. we will keep a changelog (with unreleased section to be filled in on the fly) and when doing GH Release we will provide there links to the respective changelog release sections.