mirror of
https://github.com/nerfstudio-project/nerfstudio.git
synced 2026-11-21 15:15:43 +08:00
Add pre-commit (#1949)
* Add pre-commit * Add pre-commit to docs --------- Co-authored-by: Brent Yi <yibrenth@gmail.com>
This commit is contained in:
1 parent
2b0831b6d4
commit
9584fa9b39
3 files changed
+31
-1
No files matched your search
@@ -26,14 +26,16 @@ Below are the various tooling features our team uses to maintain this codebase.
|
||||
|
||||
## Requirements
|
||||
|
||||
To install the required packages:
|
||||
To install the required packages and register the pre-commit hook:
|
||||
|
||||
```bash
|
||||
pip install -e .[dev]
|
||||
pip install -e .[docs]
|
||||
pre-commit install
|
||||
```
|
||||
|
||||
This will ensure you have the required packages to run the tests, linter, build the docs, etc.
|
||||
The pre-commit hook will ensure your commits comply with the repository's code style rules.
|
||||
|
||||
You may also need to install [pandoc](https://pandoc.org/). If you are using `conda` you can run the following:
|
||||
|
||||
|
||||
Reference in new issue
Block a user