diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index fe3ff9efe6e..5d2242f69b6 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -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'] diff --git a/docs/community/developer_docs.rst b/docs/community/developer_docs.rst index 6b0e6c1dfda..e8721664514 100644 --- a/docs/community/developer_docs.rst +++ b/docs/community/developer_docs.rst @@ -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