Skip to content

Commit b2b4386

Browse files
committed
revert
1 parent aaa6d38 commit b2b4386

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ We use [uv](https://docs.astral.sh/uv/) to manage the project.
1616

1717
0. Install uv: https://docs.astral.sh/uv/getting-started/installation/
1818
1. Clone the repository (bonus: [via SSH](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account))
19-
and `cd xarray-sql`.
19+
and `cd xarray_sql` (the project root).
2020
2. Install dev dependencies: `uv sync --dev`
2121
3. Install pre-commit hooks: `uv run pre-commit install`
2222

@@ -37,11 +37,11 @@ appreciate your help. A few things to keep in mind:
3737

3838
Here are a few requests for your development process:
3939

40-
- We require all code to be formatted and linted. These checks run automatically
41-
via pre-commit hooks (see Developer setup above). You can run them manually:
42-
```bash
43-
uv run pre-commit run --all-files
44-
```
40+
- We require all code to be formatted with `pyink` and type-checked with `mypy`.
41+
These checks run automatically via pre-commit hooks (see Developer setup above).
42+
If you need to run them manually:
43+
- Formatting: `uv run pre-commit run pyink --all-files` or `uvx pyink .`
44+
- Type checking: `uv run pre-commit run mypy --all-files` or `uv run mypy xarray_sql/`
4545
- Please include unit tests, if possible, and performance tests when you touch the core functionality (see `perf_tests/`).
4646
- It's polite to do a self review before asking for one from a maintainer. Don't stress if you forget; we all do sometimes.
4747
- Please add (or update) documentation when adding new code. We use [Google Style docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).

0 commit comments

Comments
 (0)