summaryrefslogtreecommitdiffstats
path: root/CHANGELOG.md
diff options
context:
space:
mode:
authorJoris Roovers <joris.roovers@gmail.com>2019-06-17 16:48:25 +0200
committerJoris Roovers <joris.roovers@gmail.com>2019-06-17 22:50:38 +0200
commit07738b3bd34f91977888a954f95527411babae1c (patch)
tree7501b832f981351d3608afb6a53912428b0fcc7b /CHANGELOG.md
parentd3bd68ccf42f24dacd40709eeac954c54ccaf331 (diff)
Docs for Contrib Rules
- Documented Contrib Rules: how to use them, how to write them Additional minor changes: - Renamed the ConventionalCommit id from CL1 to CT1 to align with existing conventions of using a 'T' for title rules. - Help output now wrapped at 120 chars instead of 80
Diffstat (limited to 'CHANGELOG.md')
-rw-r--r--CHANGELOG.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index f1effbb..b7d983d 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,16 @@
# Changelog #
+## v0.12.0 (In Progress) ##
+
+- [Contrib Rules](http://jorisroovers.github.io/gitlint/contrib_rules): community-contributed rules that are disabled
+ by default, but can be enabled through configuration. Contrib rules are meant to augment default gitlint behavior by
+ providing users with rules for common use-cases without forcing these rules on all gitlint users.
+ interested in contributing new rules
+ - **New Contrib Rule**: ```contrib-title-conventional-commits``` enforces the [Conventional Commits](https://www.conventionalcommits.org) spec. Details in our [documentation](http://jorisroovers.github.io/gitlint/contrib_rules/#ct1-contrib-title-conventional-commits).
+ - **New Contrib Rule**: ```cc1-contrib-requires-signed-off-by``` ensures that all commit messages contain a ```Sign-Off-By``` line. Details in our [documentation](http://jorisroovers.github.io/gitlint/contrib_rules/#cc1-contrib-requires-signed-off-by).
+ - If you're interested in adding new Contrib rules to gitlint, please start by reading the
+ [Contributing](http://jorisroovers.github.io/gitlint/contributing/) page. Thanks for considering!
+
## v0.11.0 (2019-03-13) ##
- Python 3.7 support