release-script icon indicating copy to clipboard operation
release-script copied to clipboard

Update README.md

Open ticaki opened this issue 1 year ago • 2 comments

add missing #

ticaki avatar Mar 10 '24 09:03 ticaki

@AlCalzone Note While zhe example must gsve 3 # for README.md it might be correct to havebonly 2 for CHANGELOG.md

Maybe this must be described in more Derail to avoid breaking working with CHANGELOG.nd while correnting README.md.

mcm1957 avatar Mar 10 '24 11:03 mcm1957

This isn't correct. The changelog entries in README have 3 #, while the ones in CHANGELOG only have 2 #.

The documentation is also very clear about this: grafik

If anything, we could add a sentence under usage to mention this again:

The following assumes that you keep the changelog in `CHANGELOG.md`. If you keep it in `README.md`, prepend another `#`.

or so...

AlCalzone avatar Mar 11 '24 08:03 AlCalzone