Skip to content

Improvements to Changelog #178

@AndrewAnnex

Description

@AndrewAnnex

During the last TC meeting, a topic that was discussed was the need to better communicate changes to ISIS to help with misconceptions about the ISIS release frequency. One of the approaches considered were to improve the ISIS changelog https://github.com/USGS-Astrogeology/ISIS3/blob/dev/CHANGELOG.md document, and this issue was created to facilitate discussion around ideas.

Some ideas we had were:

  1. defining some sort of length requirement for entires in the changelog to ensure pertinent changes are highlighted.
  2. creating a more-for-humans version of the changelog that doesn't discuss specific commits but attempts to communicate the most important details about the changes for developers and users separately

an idea I should have mentioned before is that 2 above could be addressed by using the space under the release subheadings (eg line under ## [7.1.0] - 2022-07-27) for a paragraph or two discussing those changes.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions