vmprof-python icon indicating copy to clipboard operation
vmprof-python copied to clipboard

please tag releases and include release notes

Open jab opened this issue 9 years ago • 2 comments

Just noticed there was a new release of vmprof. Looked for a changelog under https://pypi.python.org/pypi/vmprof, https://vmprof.readthedocs.org/, and https://github.com/vmprof/vmprof-python, but didn't find any. Went to https://github.com/vmprof/vmprof-python/releases in hopes of seeing this info there, but came up empty since you're not tagging releases.

Would you consider tagging releases and adding release notes? In the meantime, users have to look through https://github.com/vmprof/vmprof-python/commits to try to tease out what's changed when there's a new release.

Here is an example of maintaining release notes alongside each release: https://github.com/jab/bidict/releases

Check out https://github.com/blog/1547-release-your-software for a walkthrough of using this feature. GitHub makes this a really nice user experience.

Thanks for your consideration and for the great work on vmprof.

jab avatar Jan 19 '16 17:01 jab

good point, thanks, will try!

fijal avatar Jan 19 '16 17:01 fijal

Great, thanks!

jab avatar Jan 19 '16 18:01 jab

Closing. We now tag the releases. Creating more documentation is harder, PR welcome to get the ball rolling.

mattip avatar Jan 03 '24 05:01 mattip