python-package-guide icon indicating copy to clipboard operation
python-package-guide copied to clipboard

Describe what a changelog is in the documentation

Open lwasser opened this issue 2 years ago • 3 comments

In this Pr it was noted that while changelog is shown in the example Python package structure (see here) it is not mentioned in the documentation docs section. So we need to add some content on changelog best practices / link to existing resources. many thanks to @ucodery for identifying this gap. ✨

This would be a new page i think in the packaging guide and we could link to it from the peer review guide.

lwasser avatar May 26 '23 17:05 lwasser

https://keepachangelog.com might be helpful, either to link out to or to crib from

dstansby avatar Jun 12 '23 11:06 dstansby

oh wow - that's a great resources, @dstansby !! many thanks for this note. also pinging @ucodery . we will go back and edit this section to add info on changelogs. that was quite the oversight on my part!! All - feel free to open a PR if you have time - otherwise i will get to this but it might take a bit of time for me to get there!!

lwasser avatar Jun 13 '23 00:06 lwasser

PR #222 submitted!

miguelalizo avatar Apr 08 '24 19:04 miguelalizo

A PR was merged for this issue (#222). Did it complete the entire scope? Is there anything to do here?

pb-413 avatar May 21 '24 13:05 pb-413

I believe that PR closed this issue. We always accept new PRs or issues to make our content better, but its also important to recognize the wins, so I will close this. Thanks for the ping @pb-413

ucodery avatar May 22 '24 17:05 ucodery