-
Notifications
You must be signed in to change notification settings - Fork 41
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
Add CHANGELOG.md #548
Add CHANGELOG.md #548
Conversation
I think we never really discussed what we want to include here. Is the autogenerated file good enough for us? |
The auto-generated changelog is a good start, but it looks noisy to me. Particularly, if the primary audience of the changelog file is users, there's no point in mentioning changes invisible to users. Things like code refactoring, updates in testing, fixing warnings, etc. So I would propose starting with auto-generated, but going through it with a human hand to trim it down, possibly with better descriptions. |
Couple other thoughts:
|
I went through all items in the changelog to remove everything that is not user-facing/user-relevant (which is clearly opinionated). |
OK, I went through the CHANGELOG and cleaned things up. I introduced subsections for each release (New Features, Build Changes, Enhancements, Bug Fixes), and cleaned up the language for many pull requests to actually make sense from a user perspective. |
9ec7a77
to
6415cde
Compare
Co-authored-by: Damien L-G <dalg24+github@gmail.com>
Overall, I'm fine with most suggestions. I would like to revert a couple, and have questions about few others. |
Co-authored-by: Damien L-G <dalg24+github@gmail.com>
Are we good to merge then? |
Co-authored-by: Daniel Arndt <arndtd@ornl.gov>
@dalg24 Any final thoughts? |
@Rombur Can you please take a look? |
Step-3