flask-profiler icon indicating copy to clipboard operation
flask-profiler copied to clipboard

Published 20 hours ago • verified publisher icon muatik

changelog?

Open havok2063 opened this issue 7 years ago • 3 comments

Is there a changelog somewhere indicating the differences between versions? I'd like to know the features/bug fixes/changes different between 1.5 and 1.6. If there isn't one, I think it would be helpful to include.

havok2063 avatar Oct 26 '17 14:10 havok2063

@havok2063 currently changelog is not being kept. but as you said, it would be helpful.

by the way, 1.6 introduces sqlalchemy support.

muatik avatar Oct 26 '17 15:10 muatik

@havok2063 I just created a simple changelog file starting from v1.6 Is there a better way/format or this will be enough? https://github.com/muatik/flask-profiler/blob/master/changelog.txt

muatik avatar Oct 26 '17 19:10 muatik

@muatik I think the standard format is a markdown or rst file, something similar to README.md. I have created an example file in CHANGELOG.md of how I write mine. I filled it in with some info based on your release page. You can probably fill in more info. I typically differentiate sections between

  • Added - brand new features or functionality
  • Changed - change in behaviour of existing features
  • Fixed - bug fixes

but this is just a template. Feel free to modify it how you like it, or delete it.

https://github.com/muatik/flask-profiler/blob/master/CHANGELOG.md

havok2063 avatar Oct 27 '17 14:10 havok2063