Skip to content

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

@riverma

Description

@riverma

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

Metadata

Metadata

Assignees

Labels

information sharingProcess improvements involving documentation, training, guides, communication, etclow complexityTicket is relatively easy & straightforward to resolverequestedRequested by community members at a low level

Type

No type

Projects

Status

🆕 New

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions