From 8f87db25d9817d55bc90c172ed1c35d8dd3717ac Mon Sep 17 00:00:00 2001 From: Petr Korolev Date: Fri, 20 Mar 2015 14:48:20 +0200 Subject: [PATCH] Create gh-pages branch via GitHub --- index.html | 134 +++++++++++++++++++++++++++++++++++++--------------- params.json | 2 +- 2 files changed, 96 insertions(+), 40 deletions(-) diff --git a/index.html b/index.html index 9b71d17..1ae51c1 100644 --- a/index.html +++ b/index.html @@ -23,9 +23,9 @@
- Download .zip - Download .tar.gz - View on GitHub + Download .zip + Download .tar.gz + View on GitHub
@@ -61,9 +61,28 @@
  • License
    • -

    Changelog generation has never been so easy.

    +

    +Changelog generation has never been so easy:

    -

    Fully automate changelog generation - This gem generate change log file based on tags, issues and merged pull requests from Github issue tracker. This generator complies all change log format guidelines.

    +

    Fully automate changelog generation - This gem generate change log file based on tags, issues and merged pull requests (and split them to separate lists according labels) from :octocat: GitHub Issue Tracker.

    + +

    Since now you don't have to fill your CHANGELOG.md manually: just run script, relax and take a cup of :coffee: before your next release! :tada:

    + +
    +

    +What’s the point of a change log? +

    + +

    To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.

    + +

    +Why should I care? +

    + +

    Because software tools are for people. If you don’t care, why are you contributing to open source? Surely, there must be a kernel (ha!) of care somewhere in that lovely little brain of yours.

    + +

    :copyright: http://keepachangelog.com

    +

    Installation

    @@ -92,24 +111,21 @@

    Full Changelog

    -

    -Implemented enhancements:

    +

    Implemented enhancements:

    -

    -Fixed bugs:

    +

    Fixed bugs:

    -

    -Merged pull requests:

    +

    Merged pull requests:

    @@ -171,7 +189,7 @@

    GitHub token

    -

    Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token

    +

    Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token (-t, --token option)

    You can easily generate it here.

    @@ -201,36 +219,46 @@ Features and advantages of this project

    @@ -245,16 +273,42 @@

    Wikipage with list of projects

    -

    If you are using github_changelog_generator for generation change log in your project or know of project that uses it, please add it to this list.

    +

    If you are using github_changelog_generator for generation change log in your project or know another project that uses it, please add it to this list.

    Am I missed some essential feature?

    -

    Nothing is impossible!

    + -

    Open an issue and let's make generator better together!

    +

    +FAQ

    -

    Bug reports, feature requests, patches, well-wishes are always welcome!

    + + +

    GitHub Releases is a very good thing. And it's very good practice to maintain it (not so much people using it yet)! :congratulations:

    + +

    I'm not try to compare quality of auto-generated and manually generated logs.

    + +

    The Changelog like this sometimes really helps. For example:

    + +

    When I found a closed bug - it's very useful to understand, in which release it was fixed. In that case you can easily find this issue by # in CHANGELOG.md.

    + + + +

    In the end:

    + +

    I think, that GitHub Releases is more for end-users. +But CHANGELOG.md could stay in the repo for developers with detailed list of changes. +And it's nothing bad to combine GitHub Releases and CHANGELOG.md file together in that manner.

    Contributing

    @@ -266,6 +320,8 @@
  • Commit your changes (git commit -am 'Add some feature')
  • Push to the branch (git push origin my-new-feature)
  • Create a new Pull Request
    • +
  • Profit! :white_check_mark: +

    • @@ -276,7 +332,7 @@