Skip to content

Commit

Permalink
added titles and disclaimer to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Cielquan committed May 19, 2020
1 parent 2e4ef88 commit 0486429
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,17 @@ commit-msg hook for pre-commit to verify jira issues in commit messages.

See also: https://github.com/pre-commit/pre-commit

Prerequisites
=============

*Works only with python version >= 3.6*

A new version of ``pip`` that supports PEP-517/PEP-518 is required.
When the setup fails try updating ``pip``.


Usage
=====

Add this to your project's ``.pre-commit-config.yaml`` file:

Expand Down Expand Up @@ -58,6 +67,14 @@ Lastly install the hook:
$ pre-commit install -t commit-msg
Disclaimer
==========

No active maintenance is intended for this project.
You may leave an issue if you have a questions, bug report or feature request,
but I cannot promise a quick response time.


.. .############################### LINKS ###############################
.. BADGES START
Expand Down

0 comments on commit 0486429

Please sign in to comment.