Skip to content
This repository has been archived by the owner on May 4, 2022. It is now read-only.

docs(changelog): Add release notes 6.0.0 to present to changelog file #671

Merged
merged 1 commit into from
Aug 10, 2017
Merged

docs(changelog): Add release notes 6.0.0 to present to changelog file #671

merged 1 commit into from
Aug 10, 2017

Conversation

ChristianMurphy
Copy link
Contributor

Based off the excellent feedback from #666 😈

ℹ️ About Keep a Changelog
This takes a different approach to keeping a changelog.
Rather than a primarily automated process based off commit messages. 🤖
This takes the purely human approach of letting the release manager add a description of changes. 📝

While still offering some recommendations on how to structure the changelog.

🔗 from Keep a Changelog docs

Guiding Principles

  • Changelogs are for humans, not machines.
  • There should be an entry for every single version.
  • The same types of changes should be grouped.
  • Versions and sections should be linkable.
  • The latest version comes first.
  • The release date of each versions is displayed.
  • Mention whether you follow Semantic Versioning.

Types of changes

  • Added for new features.
  • Changed for changes in existing functionality.
  • Deprecated for soon-to-be removed features.
  • Removed for now removed features.
  • Fixed for any bug fixes.
  • Security in case of vulnerabilities.

🚧 Code changes

Copies release notes from GitHub releases 6.0.0 to present into CHANGLOG.md.


Contributor License Agreement adherence:

@ChristianMurphy ChristianMurphy requested review from jimhelwig and a team August 4, 2017 05:02
@ChristianMurphy ChristianMurphy changed the title docs: Add CHANGELOG.md file with release notes 6.0.0 to present docs(changelog): Add release notes 6.0.0 to present to changelog file Aug 6, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants