summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-06-19 07:00:25 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-06-19 07:00:25 +0000
commita5907b904f568d3249b7629ea9ff3b932f723ce3 (patch)
treeb82c427c125ea5fcf9d1e2fb48e4a529fc932fba /CONTRIBUTING.md
parentAdding upstream version 2.18.1. (diff)
downloadpre-commit-a5907b904f568d3249b7629ea9ff3b932f723ce3.tar.xz
pre-commit-a5907b904f568d3249b7629ea9ff3b932f723ce3.zip
Adding upstream version 2.19.0.upstream/2.19.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index adce08f..fa1678c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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