summaryrefslogtreecommitdiff
path: root/vendor/github.com/grpc-ecosystem/go-grpc-middleware/v2/CONTRIBUTING.md
blob: adf9e43d5a98c33728b6f12a4f8f79a8a429cf06 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# Contributing

We would love to have people submit pull requests and help make `grpc-ecosystem/go-grpc-middleware` even better 👍.

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 to execute the formatting check, regenerate the proto files, and run the tests and linters:

```powershell
make fmt : Run formatting across all go files

make proto : Generate proto files

make test : Run all the tests

make lint : Run linting across all go files
```

One command to rule them all:

```bash
make all
```

This will `lint`, `fmt`, regenerate proto files and documentation and run all tests.

Push to your fork and open a pull request.