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

Add a Changelog #388

Closed
sandstrom opened this issue May 19, 2016 · 3 comments
Closed

Add a Changelog #388

sandstrom opened this issue May 19, 2016 · 3 comments
Assignees
Labels

Comments

@sandstrom
Copy link

sandstrom commented May 19, 2016

Forgive me if I'm blind, but I cannot find a change log. 🙈

Here are a few things that make a change log great:

  • Made for humans, not machines, so legibility is crucial.
  • Easy to link to any section (hence Markdown over plain text).
  • One sub-section per version.
  • List releases in reverse-chronological order (newest on top).
  • Write all dates in YYYY-MM-DD format. (https://xkcd.com/1179/)
  • have an "Unreleased" section at the top for keeping track of any changes.

Source: http://keepachangelog.com

@keis
Copy link

keis commented May 20, 2016

I've been using this tool to generate changelogs a few times https://github.com/lalitkapoor/github-changes

It's not perfect but I can recommend if you just want to get something going without much effort :)

@emilevauge
Copy link
Member

Hi @sandstrom, you are right. We spoke multiple times of adding one but:

  • I wanted to update it automatically (using a generator) and I have not found a way to do that at each merge on the master
  • Knowing that, the only way is to generate it manually. As we are soon going to release the 1.0.0, I was thinking of generating a changelog at each new version starting from this version.

@emilevauge emilevauge added the kind/enhancement a new or improved feature. label May 25, 2016
@emilevauge emilevauge self-assigned this May 26, 2016
@firehist
Copy link

firehist commented Jul 4, 2016

Maybe it's not the appropriate tools, but I'm using a lot commitizen tools to generate Changelog. It follows some commit rules from Angular Team.
https://github.com/commitizen/cz-cli
https://github.com/conventional-changelog/conventional-changelog

@traefik traefik locked and limited conversation to collaborators Sep 1, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

5 participants