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 change-log to this repo #24

Merged
merged 4 commits into from
Feb 13, 2017
Merged

Add a change-log to this repo #24

merged 4 commits into from
Feb 13, 2017

Conversation

ashmaroli
Copy link
Owner

Add a CHANGELOG.md to document relevant changes.

  • Incorporate info from Releases for changes in released versions.
  • Add current unreleased changes.

Format Guide:

  • Version Heading: ### [VERSION] / [Release-Date: YY-MM-DD]
  • Section Heading: #### [Title]
  • Links to PRs:
    • Reference-links in bold with inline-code-formatting further enclosed in square-brackets.
    • Single-link: **[['#PR-No.'][]]**
    • Mutiple-links: **[['#PR-No.1'][], ['#PR-No.2'][]]**
    • Hyperlink: within the same section.

Example:

### 0.1.0 / 2017-01-01

#### Minor Improvements

  * Added Changelog. **[[`#1`][]]**
  * Added a cool feature. **[[`#2`][], [`#3`][]]**

[`#01`]: https://github.com/ashmaroli/jekyll-data/pull/1
[`#02`]: https://github.com/ashmaroli/jekyll-data/pull/2
[`#03`]: https://github.com/ashmaroli/jekyll-data/pull/3

#### Bug Fixes

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

Successfully merging this pull request may close these issues.

1 participant