Set up linting and contribution guidelines

Author: toastwaffle

.golangci.yaml

@@ -0,0 +1,10 @@
+version: "2"
+linters:
+  default: all
+formatters:
+  enable:
+    - gci
+    - gofmt
+    - gofumpt
+    - goimports
+    - golines

CONTRIBUTING.md

@@ -0,0 +1,15 @@
+# Contributing
+
+This module is primarily maintained for Thought Machine's use case, but external contributions are
+welcome.
+
+## Potential improvements
+
+* Limiting parallelism
+* Deadlock detection
+* Observability and debugging
+
+## Making changes
+
+Please run `go build ./...`, `go test`, and `golangci-lint run` before submitting a PR. Github
+Actions will also run these commands, but running them yourself means faster feedback!

README.md

@@ -29,6 +29,10 @@ of these is the `ID` type used in place of slices of keys because Golang slices
 
 ## Limitations and sharp edges
 
-* Taskgraph has no deadlock detection.
+* Taskgraph has no deadlock detection. In theory the fact that the graph is acyclic should prevent
+  deadlock, but in practice there may be other potential causes for deadlock that have not been
+  considered.
 * Taskgraph runs every task in its own goroutine, with no limitation on how many tasks can be
-  running at the same time.
+  running at the same time.
+* Taskgraph is not easy to debug and understand the execution. While there is a small amount of
+  logging and tracing, there is no way to inspect the data being passed through the graph.