Skip to content
This repository was archived by the owner on Oct 5, 2023. It is now read-only.

Proposed CHANGELOG.md file #3

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

riverma
Copy link
Contributor

@riverma riverma commented Apr 26, 2022

Purpose

  • New CHANGELOG.md file format to help provide history of significant changes for users / devs
    • Why a CHANGELOG when you have packaged releases? Packaging systems come and go, but a changelog is for the long-term.
    • Suggested update strategy is: https://semver.org whenever committed to main branch
  • Leveraging https://keepachangelog.com/en/1.0.0/ format
  • ⚠ NOTE: this is a DRAFT pull request, please commit to this PR branch with your existing release information to the changelog before merging

Proposed Changes

  • [ADD] CHANGELOG.md file with sample content

Testing

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant