CONTRIBUTING.md

thetic · Feb 24, 2025 · 8f0db03 · 8f0db03
1 parent 3b63a50
commit 8f0db03
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,20 @@
+# Contributing
+
+This project welcomes contributions.
+
+## Pull Requests
+
+Please test your changes before opening a Pull Request.
+If you need help testing, open a Draft Pull Request.
+
+This project uses `uv`.
+Be sure that your changes follow lint and formatting rules:
+
+    - `uv run ruff check`
+    - `uv run ruff format`
+
+These are required to pass in CI before merging.
+
+## Issues
+
+Please include all relevant version information, configuration, and reproduction steps when submitting an issue.