Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename History.md to CHANGELOG.md #1202

Merged
merged 1 commit into from
Aug 21, 2017
Merged

Rename History.md to CHANGELOG.md #1202

merged 1 commit into from
Aug 21, 2017

Conversation

mpkorstanje
Copy link
Contributor

In accordance with cucumber/common#251
normalization will help messaging be consistent across the board
allowing different users to be able to read all history files across
Cucumber regardless of which language specific repo of which they're
most familiar.

I have also attempted to categorize the changes to make it easier to see
at a glance what the important changes are (such as deprecations and
removals). However the current format doesn't quite lend itself for this.

After 2.0.0 is released I would like to add the categories as recommend
by Keep A Change Log[1]:

  • 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.

References:

  1. http://keepachangelog.com/en/1.0.0/

In accordance with cucumber/common#251
normalization will help messaging be consistent across the board
allowing different users to be able to read all history files across
Cucumber regardless of which language specific repo of which they're
most familiar.
@mpkorstanje mpkorstanje merged commit 3e97237 into master Aug 21, 2017
@coveralls
Copy link

Coverage Status

Coverage remained the same at 56.198% when pulling 1e31fa0 on normalize-changelog into f05d325 on master.

@mpkorstanje mpkorstanje deleted the normalize-changelog branch August 21, 2017 21:51
@lock
Copy link

lock bot commented Oct 24, 2018

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@lock lock bot locked as resolved and limited conversation to collaborators Oct 24, 2018
@mpkorstanje mpkorstanje restored the normalize-changelog branch October 4, 2019 18:20
@mpkorstanje mpkorstanje deleted the normalize-changelog branch October 4, 2019 18:21
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.

2 participants