From a79558a39653450a6bb72aa3a591a95b37a47a79 Mon Sep 17 00:00:00 2001 From: Yash Sharma Date: Wed, 3 Jun 2020 12:53:14 +0530 Subject: [PATCH] Added some description of the Makefile in the contributing.md Signed-off-by: Yash Sharma --- CONTRIBUTING.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dd52ab893..89cb00786 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,8 +7,19 @@ Fork, then clone the repo: ```bash git clone git@github.com:your-username/go-grpc-middleware.git ``` +Before submitting a patch, please make sure to run the following make commands for running checks - +Make commands for running formatting/tests/generate proto files/vetting +```powershell +make fmt : Run formatting across all go files -Before checking in please run the following: +make proto : Generate proto files + +make test : Run all the tests + +make vet : Run vetting across all go files +``` + +One command to rule them all: ```bash make all