You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-9Lines changed: 4 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -15,17 +15,12 @@ pre-commit run --all-files
15
15
16
16
## Coding guidelines
17
17
18
-
For code style, we recommend the [google style guide](https://google.github.io/styleguide/pyguide.html).
19
-
20
-
Pre-commit hooks apply the [black](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html)
21
-
code formatting.
18
+
For code style, we recommend the [PEP 8 style guide](https://peps.python.org/pep-0008/).
22
19
23
20
For docstrings we use [numpy format](https://numpydoc.readthedocs.io/en/latest/format.html).
24
21
25
-
We also use [flake8](https://flake8.pycqa.org/en/latest/) and [pylint](https://pylint.pycqa.org/en/stable/)
26
-
for further static code analysis. The pre-commit hooks show errors which you need
27
-
to fix before submitting a PR.
22
+
We use [ruff](https://docs.astral.sh/ruff/) for code formatting and static code
23
+
analysis. Ruff checks various rules including [flake8](https://docs.astral.sh/ruff/faq/#how-does-ruff-compare-to-flake8). The pre-commit hooks show errors which you need to fix before submitting a PR.
28
24
29
25
Last but not the least, we use type hints in our code which is then checked using
30
-
[mypy](https://mypy.readthedocs.io/en/stable/). Currently, mypy checks are not
31
-
strict, but will be enforced more as the API code becomes more stable.
0 commit comments