Skip to content

Add a CHANGELOG.md file to the repo and start tracking changes #151

Open

Description

@FejZa

This would help to understand what changed actually. I suggest following this guide https://keepachangelog.com/en/1.0.0/

Activity

  1. jwittner commented on Jan 29, 2019

    @jwittner
    Member

    I dig it. The Release PRs have had some notes about all the changes, but they can be hard to find and are more focused on testing the change than communicating it.

    So we could keep an Unreleased section accumulating in the 'develop' branch, and then upgrade them when moving that into 'master'.

    Would we make everyone who did a PR update the changelog?

  2. FejZa commented on Jan 29, 2019

    @FejZa
    Author

    Exactly. That's how I am managing it in my repo. Have an [Unreleased] section populate until a new release is made and then assign it the new version.

    Everyone doing a PR can add his changes to the [Unreleased]. I understand this adds some additional work to manage things but once people get used to the workflow, it's easy.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions