Skip to content

Commit

Permalink
chore: pre commit config for commitlint (#947)
Browse files Browse the repository at this point in the history
* chore: add commitlint pre-commit stage

* docs: update developer guides

(cherry picked from commit 168c1ee)
  • Loading branch information
frascuchon authored and Francisco Aranda committed Jan 31, 2022
1 parent 82369a1 commit ce6d126
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,10 @@ repos:
rev: 5.9.3
hooks:
- id: isort

- repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
rev: v2.2.0
hooks:
- id: commitlint
stages: [commit-msg]
additional_dependencies: ['@commitlint/config-conventional']
8 changes: 8 additions & 0 deletions docs/community/developer_docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,14 @@ You can install them by simply running:
pre-commit install
Install the `commit-msg` hook if you want to check your commit messages in your
contributions:

.. code-block:: bash
pre-commit install --hook-type commit-msg
The last step is to build the static UI files in case you want to work on the UI:

.. code-block:: bash
Expand Down

0 comments on commit ce6d126

Please sign in to comment.