summaryrefslogtreecommitdiffstats
path: root/README.md
blob: fac3270ea2c140df2603b05073af5b9ea19b9c96 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# gitlint: [jorisroovers.github.io/gitlint](http://jorisroovers.github.io/gitlint/) #

[![Build Status](https://travis-ci.org/jorisroovers/gitlint.svg?branch=master)](https://travis-ci.org/jorisroovers/gitlint)
[![Coverage Status](https://coveralls.io/repos/jorisroovers/gitlint/badge.svg?branch=master&service=github)](https://coveralls.io/github/jorisroovers/gitlint?branch=master)
[![PyPi Package](https://img.shields.io/pypi/v/gitlint.png)](https://pypi.python.org/pypi/gitlint)
![Supported Python Versions](https://img.shields.io/pypi/pyversions/gitlint.svg)

Git commit message linter written in python (for Linux and Mac), checks your commit messages for style.

**See [jorisroovers.github.io/gitlint](http://jorisroovers.github.io/gitlint/) for full documentation.**

<a href="http://jorisroovers.github.io/gitlint/" target="_blank"><img src="https://asciinema.org/a/30477.png" width="640"/></a>

## Contributing ##
All contributions are welcome and very much appreciated!

**I'm looking for contributors that are interested in taking a more active co-maintainer role as it's becoming increasingly difficult for me to find time to maintain gitlint. Please open a PR if you're interested - Thanks!**

See [jorisroovers.github.io/gitlint/contributing](http://jorisroovers.github.io/gitlint/contributing) for details on
how to get started - it's easy!

FYI, we maintain a [wishlist on our wiki](https://github.com/jorisroovers/gitlint/wiki/Wishlist).