add CONTRIBUTING.md

dask-contrib · Oct 7, 2024 · 5eed071 · 5eed071
1 parent ca257ca
commit 5eed071
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -130,3 +130,5 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+pyrightconfig.json
diff --git a/CONTRIBUTING.md 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
+```
Original file line number	Diff line number	Diff line change
Expand Up		@@ -130,3 +130,5 @@ venv.bak/

		# mypy
		.mypy_cache/

		pyrightconfig.json