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

changelog? #74

Open
havok2063 opened this issue Oct 26, 2017 · 3 comments
Open

changelog? #74

havok2063 opened this issue Oct 26, 2017 · 3 comments

Comments

@havok2063
Copy link

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.

@muatik
Copy link
Owner

muatik commented Oct 26, 2017

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

by the way, 1.6 introduces sqlalchemy support.

@muatik
Copy link
Owner

muatik commented Oct 26, 2017

@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

@havok2063
Copy link
Author

@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

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

No branches or pull requests

2 participants