Skip to content

Commit

Permalink
Added some description of the Makefile in the contributing.md
Browse files Browse the repository at this point in the history
Signed-off-by: Yash Sharma <yashrsharma44@gmail.com>
  • Loading branch information
yashrsharma44 committed Jun 3, 2020
1 parent a0e7c73 commit a79558a
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a79558a

Please sign in to comment.