Updated contributing docs and added pre-commit requirement. (#298)

0b01001001 · Apr 13, 2023 · 78edc00 · 78edc00
1 parent 6af3ce7
commit 78edc00
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -5,9 +5,8 @@
 ## Pull Requests
 
 * fork this repo and git clone it
-* install spectree in your virtualenv with `pip install -e .` and test it with `make test`
+* install spectree in your virtualenv with `pip install -e .[dev]` and test it with `make test`
 * create a new branch: `git checkout -b fix-<bug>`
 * make your changes (code, doc, test)
-* check the coding style `make style` and test cases `make test`
+* check the coding style `make lint` and test cases `make test`
 * open a pull request
-
diff --git a/pyproject.toml b/pyproject.toml
@@ -34,6 +34,7 @@ dev = [
     "flake8>=4,<7",
     "isort~=5.10",
     "mypy>=0.971",
+    "pre-commit",
     "pytest~=7.1",
 ]
 email = [