Skip to content

Commit 5b8d379

Browse files
author
Chris Elion
authored
update pre-commit instructions for CONTRIBUTING.md (#5130)
1 parent 23368fc commit 5b8d379

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

com.unity.ml-agents/CONTRIBUTING.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,13 @@ We run continuous integration on all PRs; all tests must be passing before the P
5252

5353
Several static checks are run on the codebase using the
5454
[pre-commit framework](https://pre-commit.com/) during CI. To execute the same
55-
checks locally, run `pip install pre-commit` and then `pre-commit run --all-files`.
55+
checks locally, run:
56+
```bash
57+
pip install pre-commit>=2.8.0
58+
pip install identify>==2.1.3
59+
pre-commit run --all-files
60+
```
61+
5662
Some hooks (for example, `black`) will output the corrected version of the code;
5763
others (like `mypy`) may require more effort to fix. You can optionally run
5864
`pre-commit install` to install it as a git hook; after this it will run on all
@@ -64,8 +70,8 @@ All python code should be formatted with
6470
[`black`](https://github.com/psf/black).
6571

6672
C# code is formatted using [`dotnet-format`](https://github.com/dotnet/format).
67-
You must have [dotnet](https://dotnet.microsoft.com/download) and
68-
`dotnet-format` installed first.
73+
You must have [dotnet](https://dotnet.microsoft.com/download) installed first
74+
(but don't need to install `dotnet-format` - `pre-commit` will do that for you).
6975

7076
### Python type annotations
7177

0 commit comments

Comments
 (0)