docs: add development.md (#227)

## Which problem is this PR solving? - make it a little easier to get started with contributions
honeycombio · Jun 17, 2023 · eb82fd7 · eb82fd7
1 parent e575aa2
commit eb82fd7
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -0,0 +1,25 @@
+# Local Development
+
+## Requirements
+
+Go: https://go.dev/doc/install
+
+## Install Dependencies
+
+```shell
+go mod download
+```
+
+## Run Tests
+
+To run all tests:
+
+```shell
+go test -race -v ./...
+```
+
+To run individual tests:
+
+```shell
+go test -race -v -run TestEmptyHoneycombTransmission ./...
+```
diff --git a/README.md b/README.md
@@ -16,6 +16,8 @@ Golang 1.17+
 
 ## Contributions
 
+See [DEVELOPMENT.md](./DEVELOPMENT.md)
+
 Features, bug fixes and other changes to libhoney are gladly accepted. Please
 open issues or a pull request with your change. Remember to add your name to the
 CONTRIBUTORS file!