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
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).
20
20
2. Install dev dependencies: `uv sync --dev`
21
21
3. Install pre-commit hooks: `uv run pre-commit install`
22
22
@@ -37,11 +37,11 @@ appreciate your help. A few things to keep in mind:
37
37
38
38
Here are a few requests for your development process:
39
39
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/`
45
45
- Please include unit tests, if possible, and performance tests when you touch the core functionality (see `perf_tests/`).
46
46
- 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.
47
47
- 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