Skip to content

Commit 9fea6be

Browse files
committed
docs(pre-commit): Add info about the included hooks
1 parent ebd4a26 commit 9fea6be

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

Diff for: docs/en/contributing.rst

+10
Original file line numberDiff line numberDiff line change
@@ -440,6 +440,16 @@ For checking the code style and other code quality checks, we use pre-commit hoo
440440
These hooks will be automatically run by the CI when a Pull Request is marked as ``Status: Pending Merge``.
441441
You can check which hooks are being run in the ``.pre-commit-config.yaml`` file.
442442

443+
Currently, we have hooks for the following tasks:
444+
445+
* Formatters for C, C++, Python, Bash, JSON, Markdown and ReStructuredText files;
446+
* Linters for Python, Bash and prose (spoken language);
447+
* Checking for spelling errors in the code and documentation;
448+
* Removing trailing whitespaces and tabs in the code;
449+
* Checking for the presence of private keys and other sensitive information in the code;
450+
* Fixing the line endings and end of files (EOF) in the code;
451+
* And more.
452+
443453
You can read more about the pre-commit hooks in the `pre-commit documentation <https://pre-commit.com/>`_.
444454

445455
If you want to run the pre-commit hooks locally, you first need to install the required dependencies by running:

0 commit comments

Comments
 (0)