From fc3397fddd038cdae7b657a24e5e330dc2d8f764 Mon Sep 17 00:00:00 2001
From: Amethyst Reese <amethyst@n7.gg>
Date: Tue, 1 Aug 2023 19:44:29 -0700
Subject: [PATCH] Add contributor guide from pyproject-template (#159)

Fixes #150
---
 CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..ab121a7
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,28 @@
+# Contributing to µfmt
+
+## Setup
+
+Create a fresh development enviroment, and install the
+appropriate tools and dependencies:
+
+    $ make venv
+    $ source .venv/bin/activate
+
+
+## Validate
+
+With the virtualenv activated, run the tests and linters:
+
+    $ make test lint
+
+
+## Submit
+
+Before submitting a pull request, please ensure
+that you have done the following:
+
+* Documented changes or features in README.md
+* Added appropriate license headers to new files
+* Written or modified tests for new functionality
+* Used `make format` to format code appropriately
+* Validated and tested code with `make test lint`