Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release Notes for Version changes #184

Open
tylerbarna opened this issue Jul 30, 2023 · 0 comments
Open

Release Notes for Version changes #184

tylerbarna opened this issue Jul 30, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@tylerbarna
Copy link
Collaborator

Feature Summary
Now that we're more consistently putting out releases of nmma, it might be good to have more documentation regarding the changes between numbered releases

Usage / behavior
This wouldn't be particularly user-facing in regards to actually using the package, but release pages would be accompanied by release notes that detail what has changed since the previous numbered version.

Alternative Solutions
While these can be manually written, there also seems to be a GitHub tool for automatically generating basic release notes that could be used to reduce the time required to implement it.

Implementation details
Include a readme file in numbered releases (example: numpy) and/or maintain a running changelog that is linked to each numbered release (example: astropy)

@tylerbarna tylerbarna added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant