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 #197

Closed
mxochicale opened this issue Jan 18, 2023 · 3 comments
Closed

Release notes #197

mxochicale opened this issue Jan 18, 2023 · 3 comments
Labels
p2-medium Medium priority

Comments

@mxochicale
Copy link
Contributor

I am having issues when using different versions of scikit-surgeryvtk (e.g., v1.1.0 and v1.0.6: SciKit-Surgery/scikit-surgerytutorial01#34). Version changes are not obvious to me unless you look the commit logs. I think it will be helpful to add releases notes to this one and perhaps to other SciKit-Surgery libs (e.g., Highlights, Backwards Incompatible Change, New Features, Improvements, Performance, Documentation, etc https://github.com/pytorch/pytorch/releases)

Thanks

@thompson318
Copy link
Collaborator

I agree that would be good practice. We usually put a short message for each tag, but we could do better.

@mxochicale
Copy link
Contributor Author

mxochicale commented Feb 1, 2023

It seems that pylint might be a good example on creating release notes, containing:

  • Summary -- Release highlights
  • What's new in Pylint 2.16.0? Changes requiring user actions
  • New Features
  • New Checks
  • Extensions
  • False Positives Fixed
  • False Negatives Fixed
  • Other Bug Fixes
  • Other Changes
  • Internal Changes
  • Contributors

See more: https://github.com/PyCQA/pylint/releases/tag/v2.16.0

@mxochicale
Copy link
Contributor Author

Another good example of release notes is the log from pytorch:
https://github.com/pytorch/pytorch/releases

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p2-medium Medium priority
Projects
None yet
Development

No branches or pull requests

2 participants