Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 72bd594

Browse filesBrowse files
committed
docs(pre-commit): Add info about the included hooks
1 parent 97bc308 commit 72bd594
Copy full SHA for 72bd594

File tree

1 file changed

+10
-0
lines changed
Filter options

1 file changed

+10
-0
lines changed

‎docs/en/contributing.rst

Copy file name to clipboardExpand all lines: docs/en/contributing.rst
+10Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -441,6 +441,16 @@ For checking the code style and other code quality checks, we use pre-commit hoo
441441
These hooks will be automatically run by the CI when a Pull Request is marked as ``Status: Pending Merge``.
442442
You can check which hooks are being run in the ``.pre-commit-config.yaml`` file.
443443

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

446456
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 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.