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

Create CHANGELOG.md #321

Merged
merged 2 commits into from
Dec 22, 2019
Merged

Create CHANGELOG.md #321

merged 2 commits into from
Dec 22, 2019

Conversation

woop
Copy link
Member

@woop woop commented Nov 24, 2019

Proposing to add a CHANGELOG.md file which uses https://github.com/github-changelog-generator/github-changelog-generator to create a changelog from our development history.

Given that our PRs and commits can be poorly named, I am suggesting the following strategy

  • Have CHANGELOG.md as the source of truth. Keep it as verbose as possible
  • Try to clean up items in the list to be more descriptive.
  • Add a summary section for releases to the file as well. The summary should mostly be focused on any user focused changes that we have made (new features, bug fixes).
  • The summary is also added to the "release" in GitHub.
  • Link back from the "release" in GitHub to the CHANGELOG.md to see the full history.

@feast-ci-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: woop

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[Full Changelog](https://github.com/gojek/feast/compare/v0.1.8...v0.3.0)

**Summary:**

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zhilingc @davidheryanto anything else we want to add here?

@woop woop added the lgtm label Dec 22, 2019
@woop woop merged commit 197c668 into master Dec 22, 2019
@davidheryanto davidheryanto deleted the woop-create-changelog branch December 23, 2019 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants