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

Tidy needs a changelog #776

Closed
petdance opened this issue Nov 21, 2018 · 4 comments
Closed

Tidy needs a changelog #776

petdance opened this issue Nov 21, 2018 · 4 comments

Comments

@petdance
Copy link
Contributor

There is no documentation in the project that says what changes have been made in each version. This is crucial for users to know if they should upgrade to a new version, and to know what behavior has changed because of an unexpected problem in an upgrade.

@geoffmcl
Copy link
Contributor

@petdance we do add a Release Notes 5.6 for each release...

But that is just a massage of what is available from the git repo, by $ git log -p, for all to see, at any time...

At this time, tidy does not maintain a changelog, in the traditional sense...

If someone want to step up and say manually manage a better changelog, then look forward to ideas on that... thanks...

@bmix
Copy link

bmix commented Jan 8, 2019

It may be sufficient for the developers to mark their contributions with 'i' for 'internal' and 'u' for 'user-facing', or something like that. This way the changelog could be automated: Only changes would be retrieved (not author and git interna) and only those, which have the 'u' flag set, would be printed to a user facing Release-History file, like change of command-line options, behavior, etc.

@balthisar
Copy link
Member

I will begin to generate better changelogs with the 5.8 release, which is coming in the next few days. Closing this.

@petdance
Copy link
Contributor Author

petdance commented Jul 9, 2021

Let me know if there's some way I can help. Thanks.

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

No branches or pull requests

4 participants