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

[Improve Existing Best Practice Guide]: CHANGELOG should be more about high-level news / updates for a broader audience #166

Open
riverma opened this issue Aug 2, 2024 · 1 comment
Assignees
Labels
information sharing Process improvements involving documentation, training, guides, communication, etc requested Requested by community members at a low level

Comments

@riverma
Copy link
Collaborator

riverma commented Aug 2, 2024

Checked for duplicates

Yes - I've already checked

Best Practice Guide Category

Documentation

Best practice guide URL

https://nasa-ammos.github.io/slim/docs/guides/documentation/change-log/

Describe the improvement

We've seen the evolution of tools like GitHub Releases, and we'd like to recommend two options:

  1. Remove the need for a CHANGELOG.md given the fact of strong overlap with GitHub Releases
  2. Morph CHANGELOG.md to point to specific release information elsewhere, but focus on high-level changes for end-users
@riverma riverma added requested Requested by community members at a low level information sharing Process improvements involving documentation, training, guides, communication, etc labels Aug 2, 2024
@yunks128
Copy link
Contributor

yunks128 commented Oct 1, 2024

I updated CHANGELOG.md focusing on high-level changes for end users and pointing to the release link (following the option 2): #174

@hookhua Do you have any preference between options 1 and 2? Thanks for your suggestion!

@yunks128 yunks128 self-assigned this Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
information sharing Process improvements involving documentation, training, guides, communication, etc requested Requested by community members at a low level
Projects
Status: 🆕 New
Development

No branches or pull requests

2 participants