will/github-changelog-generator
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Petr Korolev 2015-02-24 15:53:11 +02:00
parent 4f4bae5719
commit b36037c49f
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -109,13 +109,15 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte
##Features and advantages of this project
- Generate canonical change log file, followed by [keepachangelog.com guidlines](http://keepachangelog.com/)
- Support **Unreleased** issues (closed issues that have not yet released)
- Customize issues, that should be added to changelog
- Custom date format supported
- Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of required version
- Ability to exclude specific issues from change log (by labels)
- Automatically exclude "questions" - issues marked as `question` labels (and other issues, that should'n be in change log file: with `duplicate invalid wontfix` labels)
- Automatically split issues by type
- Simply add links for all closed issues and merged pull requests
- Possible to generate **Unreleased** changes (closed issues that have not released yet)
- Flexible format customisation:
- Customize issues, that should be added to changelog
- Custom date format supported
- Ability to manually specify in which version issue was fixed (in case, when closed date is not match) by setting `milestone` of issue the same name as tag of required version
- Ability to exclude specific issues from change log (by labels)
- Automatically exclude "questions" - issues marked as `question` labels (and other issues, that should'n be in change log file: with `duplicate invalid wontfix` labels)
- Distinguish bug fixes, enchantments, and closed issues according labels.
- **Issues** (closed issues w/o any labels)
- **Merged pull-requests** (all merged pull-requests)
- **Bug-fixes** (by label `bug` in issue)