diff --git a/.gitignore b/.gitignore index 81601c75..159b4dd2 100644 --- a/.gitignore +++ b/.gitignore @@ -130,3 +130,5 @@ venv.bak/ # mypy .mypy_cache/ + +pyrightconfig.json diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..b4990a7e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +# Contributing to dask-awkward + +Install the development environment (once) with + +```bash +uv venv +uv pip install -e '.[io,docs,test]' +pre-commit install +``` + +Source development environment with + +```bash +source .venv/bin/activate +``` + +Run tests with + +```bash +pytest . +``` + +Build documentation with + +```bash +cd docs && make html +```