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

Add CHANGELOG.md #548

Merged
merged 22 commits into from
Sep 29, 2021
Merged

Add CHANGELOG.md #548

merged 22 commits into from
Sep 29, 2021

Conversation

masterleinad
Copy link
Collaborator

@masterleinad masterleinad commented Sep 23, 2021

Step-3

@masterleinad
Copy link
Collaborator Author

I think we never really discussed what we want to include here. Is the autogenerated file good enough for us?

@aprokop
Copy link
Contributor

aprokop commented Sep 24, 2021

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.

@aprokop aprokop closed this Sep 24, 2021
@aprokop aprokop reopened this Sep 24, 2021
@aprokop
Copy link
Contributor

aprokop commented Sep 24, 2021

Couple other thoughts:

  • I don't think we need changelog for all tags
    Specifically, the kokkos-* does not need changelog. Those tags serve a different purpose.
  • I don't think we need authors in the CHANGELOG
  • I think we don't need closed issues

@masterleinad
Copy link
Collaborator Author

I went through all items in the changelog to remove everything that is not user-facing/user-relevant (which is clearly opinionated).

@masterleinad masterleinad marked this pull request as ready for review September 27, 2021 18:55
@aprokop
Copy link
Contributor

aprokop commented Sep 28, 2021

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.

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
masterleinad and others added 2 commits September 28, 2021 09:57
@masterleinad
Copy link
Collaborator Author

@dalg24 @aprokop I went through the additional suggestions and applied most of them directly and the others with minor modifications please let me know if this looks good to you now.

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@aprokop
Copy link
Contributor

aprokop commented Sep 28, 2021

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>
@masterleinad
Copy link
Collaborator Author

@aprokop I saw that you pushed another commit addressing @dalg24's comments. Are both of you happy with the current status now? It looks OK to me.

@masterleinad
Copy link
Collaborator Author

Are we good to merge then?

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: Daniel Arndt <arndtd@ornl.gov>
CHANGELOG.md Outdated Show resolved Hide resolved
@masterleinad
Copy link
Collaborator Author

@dalg24 Any final thoughts?

@masterleinad
Copy link
Collaborator Author

@Rombur Can you please take a look?

@masterleinad masterleinad requested a review from Rombur September 28, 2021 18:49
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@masterleinad masterleinad requested a review from Rombur September 28, 2021 19:53
CHANGELOG.md Outdated Show resolved Hide resolved
@aprokop aprokop merged commit 15b7a5a into arborx:master Sep 29, 2021
@aprokop aprokop deleted the add_changelog branch October 6, 2021 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants