From b0d1afb6014034a6692d86671f7c8d51a83d74ec Mon Sep 17 00:00:00 2001 From: Mike Farah Date: Fri, 21 Feb 2020 21:16:47 +1100 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b0c2dea..d38f42f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,8 @@ +1. Install (golang)[https://golang.org/] 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 +2. Run `make [local] test` to ensure you can run the existing tests +3. Write unit tests - (see existing examples). Changes will not be accepted without corresponding unit tests. +4. Make the code changes. 5. `make [local] test` to lint code and run tests -6. profit. ok no profit, but raise a PR and get kudos :) +6. Profit! ok no profit, but raise a PR and get kudos :)