[Improve Existing Best Practice Guide]: CHANGELOG should be more about high-level news / updates for a broader audience
Open
@yunks128 is already working on this.
Since Oct 1, 2024.
information sharing
low complexity
requested
- Dominant language
- JavaScript
- Stars
- 36
- Forks
- 14
- PR merge metrics
- No merged PRs in 30d
Description
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:
- Remove the need for a CHANGELOG.md given the fact of strong overlap with GitHub Releases
- Morph CHANGELOG.md to point to specific release information elsewhere, but focus on high-level changes for end-users
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.