gitlint-core/README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# Gitlint-core

# gitlint: [jorisroovers.github.io/gitlint](https://jorisroovers.github.io/gitlint/) #
|             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Package     | [![PyPi Package](https://img.shields.io/pypi/v/gitlint)](https://pypi.python.org/pypi/gitlint-core) ![Supported Python Versions](https://img.shields.io/pypi/pyversions/gitlint-core.svg) ![PyPI - Downloads](https://img.shields.io/pypi/dm/gitlint-core) [![License - MIT](https://img.shields.io/badge/license-MIT-9400d3.svg)](https://spdx.org/licenses/)                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Development | [![Tests](https://github.com/jorisroovers/gitlint/workflows/Tests%20and%20Checks/badge.svg)](https://github.com/jorisroovers/gitlint/actions?query=workflow%3A%22Tests+and+Checks%22) [![Coverage Status](https://coveralls.io/repos/github/jorisroovers/gitlint/badge.svg?branch=fix-coveralls)](https://coveralls.io/github/jorisroovers/gitlint?branch=fix-coveralls) [![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v0.json)](https://github.com/charliermarsh/ruff) [![format - Black](https://img.shields.io/badge/format-black-000000.svg)](https://github.com/psf/black) [![types - mypy](https://img.shields.io/badge/types-mypy-blue.svg)](https://github.com/python/mypy) |

Git commit message linter written in python, checks your commit messages for style.

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

<a href="https://jorisroovers.github.io/gitlint/" target="_blank">
<img src="https://raw.githubusercontent.com/jorisroovers/gitlint/main/docs/images/readme-gitlint.png" />
</a>

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

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

We maintain a [loose project plan on Github Projects](https://github.com/users/jorisroovers/projects/1/views/1).