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 ChangeLog #18

Closed
ai opened this issue Jun 12, 2017 · 5 comments
Closed

Add ChangeLog #18

ai opened this issue Jun 12, 2017 · 5 comments

Comments

@ai
Copy link

ai commented Jun 12, 2017

Reasons: http://keepachangelog.com/en/0.3.0/

Right now I need to update from 1.2 to 1.3 and can’t understand what are new features — commits list long and not clear.

@evilpacket
Copy link
Contributor

Good idea.

@evilpacket
Copy link
Contributor

Given the speed at which things happen though umm it's unlikely to be done quickly (just setting expectations :). Is there a good way that you know to do this without it being a manual pain in the posterior?

@ai
Copy link
Author

ai commented Jun 12, 2017

You can just start writing ChangeLog for new releases. It will be better than nothing.

@pdehaan
Copy link
Contributor

pdehaan commented Jun 13, 2017

Super simple implementation using changelog in PR #19. I had to manually delete some non-informational commit messages. 🤷‍♂️

Also, not sure how well this plays with non-published versions of the module. So I think it won't show any commits since the last version was published to npm.

@ai
Copy link
Author

ai commented Jun 13, 2017

Yeap, autogeneration is good solution for old versions.

Only now, that I think manually ChangeLog for new versions are much better. You can highlight breaking changes and describe changes from user perspective, not code perspective.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants