third-party/pre-commit
1
0
Fork 0
mirror of https://github.com/pre-commit/pre-commit.git synced 2026-04-15 01:51:46 +04:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

add additional info to healthy-after-install check

Browse source
This commit is contained in:
Anthony Sottile 2022-04-16 14:59:46 -04:00
parent 2562c7f796
commit 07554e9525
27 changed files with 137 additions and 79 deletions
Download patch file Download diff file Expand all files Collapse all files

7
CONTRIBUTING.md
View file

@ -117,15 +117,16 @@ get_default_version = helpers.basic_default_version
`python` is currently the only language which implements this api
#### `healthy`
#### `health_check`
This is used to check whether the installed environment is considered healthy.
This function should return `True` or `False`.
This function should return a detailed message if unhealthy or `None` if
healthy.
You generally don't need to implement this on a first pass and can just use:
```python
healthy = helpers.basic_healthy
health_check = helpers.basic_healthy_check
```
`python` is currently the only language which implements this api, for python