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.

Sign up for GitHub

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

Jump to bottom

Look in to adding CHANGELOG.md #51

Closed
arawinters opened this issue Jun 11, 2019 · 1 comment
Closed

Look in to adding CHANGELOG.md #51

arawinters opened this issue Jun 11, 2019 · 1 comment
Labels
enhancement New feature request

Comments

@arawinters
Copy link
Contributor

We should add a CHANGELOG.md living in the project root. This can be manually curated, or perhaps automagically generated from pulls/tags/releases.

see: https://keepachangelog.com/en/1.0.0/ for more information on changelogs and why people need them.
@arawinters arawinters added the enhancement New feature request label Jun 11, 2019
@docktermj
Copy link
Contributor

Excellent! I'm of the same mind. I put one at https://github.com/Senzing/docker-senzing-base/blob/master/CHANGELOG.md following the suggestions from keepachangelog.com.

I also created an issue for them olivierlacan/keep-a-changelog#305 to illustrate markdown linting.

arawinters added a commit that referenced this issue Jun 20, 2019
@arawinters
#51 added CHANGELOG.md to project
1acb054
arawinters added a commit that referenced this issue Jun 20, 2019
@arawinters
#51 added link for 1.0.5 release tag
2b83118
@arawinters arawinters mentioned this issue Dec 10, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@docktermj @arawinters