Skip to content

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

@ashmaroli ashmaroli merged commit 521bdff into master Feb 13, 2017
@ashmaroli ashmaroli deleted the changelog branch February 27, 2017 17:18
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