Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added some description of the Makefile in the contributing.md #298

Merged
merged 1 commit into from
Jun 3, 2020
Merged

Added some description of the Makefile in the contributing.md #298

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,19 @@ Fork, then clone the repo:
```bash
git clone [email protected]: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