summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-09-04 09:08:17 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-09-04 09:08:17 +0000
commit3f3add2bc6aafde4b257458dc6e86bc3aaffca0f (patch)
tree8e0dfd4750bb9b10a26b95b4cc2610ca34e6420d /CONTRIBUTING.md
parentAdding upstream version 3.3.3. (diff)
downloadpre-commit-3f3add2bc6aafde4b257458dc6e86bc3aaffca0f.tar.xz
pre-commit-3f3add2bc6aafde4b257458dc6e86bc3aaffca0f.zip
Adding upstream version 3.4.0.upstream/3.4.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ab3a929..da7f943 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -92,7 +92,7 @@ language, for example:
here are the apis that should be implemented for a language
-Note that these are also documented in [`pre_commit/languages/all.py`](https://github.com/pre-commit/pre-commit/blob/main/pre_commit/languages/all.py)
+Note that these are also documented in [`pre_commit/lang_base.py`](https://github.com/pre-commit/pre-commit/blob/main/pre_commit/lang_base.py)
#### `ENVIRONMENT_DIR`
@@ -111,7 +111,7 @@ one cannot be determined, return `'default'`.
You generally don't need to implement this on a first pass and can just use:
```python
-get_default_version = helpers.basic_default_version
+get_default_version = lang_base.basic_default_version
```
`python` is currently the only language which implements this api
@@ -125,7 +125,7 @@ healthy.
You generally don't need to implement this on a first pass and can just use:
```python
-health_check = helpers.basic_healthy_check
+health_check = lang_base.basic_health_check
```
`python` is currently the only language which implements this api, for python
@@ -137,7 +137,7 @@ this is the trickiest one to implement and where all the smart parts happen.
this api should do the following things
-- (0th / 3rd class): `install_environment = helpers.no_install`
+- (0th / 3rd class): `install_environment = lang_base.no_install`
- (1st class): install a language runtime into the hook's directory
- (2nd class): install the package at `.` into the `ENVIRONMENT_DIR`
- (2nd class, optional): install packages listed in `additional_dependencies`