Create initial CONTRIBUTING.md doc

schemahero · Dec 13, 2019 · 2d781fd · 2d781fd
1 parent 92f26bf
commit 2d781fd
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,5 @@
+# Contributing to SchemaHero
+
+This will eventually be the guide describing how to contribute to SchemaHero and how to set up a dev environment.
+
+The recommended dev workflow is to run a lightweight local Kubernetes cluster such as [microk8s](https://microk8s.io/), with `kubectl` configured with that cluster as the default context, and then to run `make install` to build and deploy your local changes to that cluster.