From 1cc20d52bb53d5bf7f6ca27c84ca27fa31042be6 Mon Sep 17 00:00:00 2001 From: Mike Farah Date: Fri, 21 Feb 2020 21:11:34 +1100 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b0c2dea --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,6 @@ +1. Run `scripts/devtools.sh` to install the required devtools +2. Run `make [local] vendor` to install the vendor dependencies +3. Write unit tests - see existing examples +4. Make the code updates +5. `make [local] test` to lint code and run tests +6. profit. ok no profit, but raise a PR and get kudos :)