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

Documentation: Create CHANGELOG.md #52

Closed
scrabill opened this issue Oct 21, 2017 · 1 comment
Closed

Documentation: Create CHANGELOG.md #52

scrabill opened this issue Oct 21, 2017 · 1 comment

Comments

@scrabill
Copy link
Owner

scrabill commented Oct 21, 2017

Since this project was posted on Github there have been several updates.

Instead of cluttering up the README.md file, the updates may be better suited in a CHANGELOG.md file. This way, updates with added features, etc, can be seen in one place. The template for the changelog can include:

  • Date
  • List of features added (or removed)
  • Screenshot to show changes (optional)

Here's an idea of what the changelog can look like: http://keepachangelog.com/en/1.0.0/

Feel free to ask questions below before starting a pull request

@jessecalton
Copy link
Contributor

Hello! Has this hacktoberfest issue been claimed yet? I'll take a stab at it!

kaysiz added a commit to kaysiz/how-many-days-until-halloween that referenced this issue Oct 21, 2017
Added CHANGELOG.md scrabill#52
scrabill added a commit that referenced this issue Oct 23, 2017
Fixes issues #52 and #53 - creates changelog and moves updates from readme to it
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants