pyOpenSci / python-package-guide

Scientific Python package recommendations & guidance curated by pyOpenSci
https://www.pyopensci.org/python-package-guide/
Other
94 stars 52 forks source link

Add: changelog-file.md to the Docs-for-Contributors-and-Maintainers section. #222

Closed miguelalizo closed 5 months ago

miguelalizo commented 5 months ago

Addresses Issue #215 - Describe what a changelog is in the documentation

miguelalizo commented 5 months ago

I think this addition is in a good state to be review. I tried to capture the information from the issue and maybe a bit more. Open to discussion if anything is missing or needs to be changed!

lwasser commented 5 months ago

@miguelalizo this page is great. Thank you for another wonderful PR.

Note: when we add new content to our pyOpenSci guidebook, we always have a community review period! I've left a bit of feedback. I also opened the pr up for community review. I gave folks a week to provide feedback. I will check back in next week and we will then get this merged!

miguelalizo commented 5 months ago

@lwasser Thanks for leaving some feedback! I'm having trouble finding where you left the feedback. Is it tied to this PR somwhere?

miguelalizo commented 5 months ago

@lwasser @ucodery thanks for the feedback! I made some edits and left some comments in the reviews to try to clarify any doubts I had.

tkoyama010 commented 1 month ago

@all-contributors please add @miguelalizo for doc

allcontributors[bot] commented 1 month ago

@tkoyama010

I've put up a pull request to add @miguelalizo! :tada: