esp-idf/docs/en/contribute/install-pre-commit-hook.rst

Install Pre-commit Hook for ESP-IDF Project
===========================================

:link_to_translation:`zh_CN:[中文]`

Required Dependency
-------------------

Python 3.8.* or above. This is our recommended Python version for ESP-IDF developers.

If you still have Python versions not compatible, update your Python versions before installing the pre-commit hook.

Install ``pre-commit``
----------------------

Run ``pip install pre-commit``

Install ``pre-commit`` Hook
---------------------------

1. Go to the ESP-IDF project directory.

2. Run ``pre-commit install --allow-missing-config -t pre-commit -t commit-msg``. Install hook by this approach will let you commit successfully even in branches without the ``.pre-commit-config.yaml``

3. pre-commit hook will run automatically when you are running ``git commit`` command

Uninstall ``pre-commit`` Hook
-----------------------------

Run ``pre-commit uninstall``

What Is More?
-------------

For detailed usage, please refer to the documentation of pre-commit_.

.. _pre-commit: https://pre-commit.com/

Common Problems For Windows Users
---------------------------------

``/usr/bin/env: python: Permission denied.``

   If you are in Git Bash, please check the python executable location by run ``which python``.

   If the executable is under ``~/AppData/Local/Microsoft/WindowsApps/``, then it is a link to Windows AppStore, not a real one.

   Please install Python manually and update this in your ``PATH`` environment variable.


Your ``USERPROFILE`` contains non-ASCII characters

   ``pre-commit`` may fail when initializing an environment for a particular hook when the path of ``pre-commit``'s cache contains non-ASCII characters. The solution is to set ``PRE_COMMIT_HOME`` to a path containing only standard characters before running pre-commit.

   - CMD: ``set PRE_COMMIT_HOME=C:\somepath\pre-commit``
   - PowerShell: ``$Env:PRE_COMMIT_HOME = "C:\somepath\pre-commit"``
   - git bash: ``export PRE_COMMIT_HOME="/c/somepath/pre-commit"``
docs: update format issues for both EN and CN under security and contribute folder 2023-08-22 23:59:44 +08:00			`Install Pre-commit Hook for ESP-IDF Project`
add contributing docs 2020-10-30 19:31:55 +08:00			`===========================================`

docs: Provide CN translation for contribute/copyright-guide and install-pre-commit-hook 2023-07-31 19:39:28 +08:00			:link_to_translation:`zh_CN:[中文]`

Fix windows error by upgrading pre-commit-hook version. drop python 2.7 support. Now we only support python 3.6.1+ 2020-11-04 10:23:47 +08:00			`Required Dependency`
			`-------------------`

docs: update format issues for both EN and CN under security and contribute folder 2023-08-22 23:59:44 +08:00			`Python 3.8.* or above. This is our recommended Python version for ESP-IDF developers.`
Fix windows error by upgrading pre-commit-hook version. drop python 2.7 support. Now we only support python 3.6.1+ 2020-11-04 10:23:47 +08:00
docs: Provide CN translation for contribute/copyright-guide and install-pre-commit-hook 2023-07-31 19:39:28 +08:00			`If you still have Python versions not compatible, update your Python versions before installing the pre-commit hook.`
Fix windows error by upgrading pre-commit-hook version. drop python 2.7 support. Now we only support python 3.6.1+ 2020-11-04 10:23:47 +08:00
docs: update format issues left in EN docs 2023-09-13 17:05:23 +08:00			Install ``pre-commit``
			`----------------------`
add contributing docs 2020-10-30 19:31:55 +08:00
			Run ``pip install pre-commit``

docs: update format issues left in EN docs 2023-09-13 17:05:23 +08:00			Install ``pre-commit`` Hook
			`---------------------------`
add contributing docs 2020-10-30 19:31:55 +08:00
docs: update format issues for both EN and CN under security and contribute folder 2023-08-22 23:59:44 +08:00			`1. Go to the ESP-IDF project directory.`
add contributing docs 2020-10-30 19:31:55 +08:00
docs(contributor_guide): Update install pre-commit instructions 2023-06-28 13:41:49 +02:00			2. Run ``pre-commit install --allow-missing-config -t pre-commit -t commit-msg``. Install hook by this approach will let you commit successfully even in branches without the ``.pre-commit-config.yaml``
add contributing docs 2020-10-30 19:31:55 +08:00
docs: update format issues for both EN and CN under security and contribute folder 2023-08-22 23:59:44 +08:00			3. pre-commit hook will run automatically when you are running ``git commit`` command
add contributing docs 2020-10-30 19:31:55 +08:00
docs: update format issues left in EN docs 2023-09-13 17:05:23 +08:00			Uninstall ``pre-commit`` Hook
docs: Provide CN translation for contribute/copyright-guide and install-pre-commit-hook 2023-07-31 19:39:28 +08:00			`-----------------------------`
Add line to documentation how to uninstall pre-commit. 2021-04-19 13:14:25 +03:00
			Run ``pre-commit uninstall``

docs: update format issues for both EN and CN under security and contribute folder 2023-08-22 23:59:44 +08:00			`What Is More?`
			`-------------`
add contributing docs 2020-10-30 19:31:55 +08:00
Add copyright check to pre-commit-config 2021-09-08 17:38:14 +02:00			`For detailed usage, please refer to the documentation of pre-commit_.`
add contributing docs 2020-10-30 19:31:55 +08:00
docs: update redirected links 2022-04-28 14:34:20 +08:00			`.. _pre-commit: https://pre-commit.com/`
add contributing docs 2020-10-30 19:31:55 +08:00
			`Common Problems For Windows Users`
			`---------------------------------`

Add copyright check to pre-commit-config 2021-09-08 17:38:14 +02:00			``/usr/bin/env: python: Permission denied.``
add contributing docs 2020-10-30 19:31:55 +08:00
docs: update format issues for both EN and CN under security and contribute folder 2023-08-22 23:59:44 +08:00			If you are in Git Bash, please check the python executable location by run ``which python``.
add contributing docs 2020-10-30 19:31:55 +08:00
docs: update format issues for both EN and CN under security and contribute folder 2023-08-22 23:59:44 +08:00			If the executable is under ``~/AppData/Local/Microsoft/WindowsApps/``, then it is a link to Windows AppStore, not a real one.
add contributing docs 2020-10-30 19:31:55 +08:00
docs: Provide CN translation for contribute/copyright-guide and install-pre-commit-hook 2023-07-31 19:39:28 +08:00			Please install Python manually and update this in your ``PATH`` environment variable.
Add copyright check to pre-commit-config 2021-09-08 17:38:14 +02:00

docs: Provide CN translation for contribute/copyright-guide and install-pre-commit-hook 2023-07-31 19:39:28 +08:00			Your ``USERPROFILE`` contains non-ASCII characters
Add copyright check to pre-commit-config 2021-09-08 17:38:14 +02:00
			``pre-commit`` may fail when initializing an environment for a particular hook when the path of ``pre-commit``'s cache contains non-ASCII characters. The solution is to set ``PRE_COMMIT_HOME`` to a path containing only standard characters before running pre-commit.

			- CMD: ``set PRE_COMMIT_HOME=C:\somepath\pre-commit``
			- PowerShell: ``$Env:PRE_COMMIT_HOME = "C:\somepath\pre-commit"``
			- git bash: ``export PRE_COMMIT_HOME="/c/somepath/pre-commit"``