|
| 1 | +# The gRPC-Gateway project is maintained by volunteers in their spare time. Please follow these troubleshooting steps before submitting an issue. |
1 | 2 |
|
2 | | -# Please follow the general troubleshooting steps first: |
3 | | - |
4 | | -- [ ] Update your protoc to the [latest version](https://github.com/google/protobuf/releases) |
5 | | -- [ ] Update your copy of `grpc-gateway` to the latest version from github. with |
6 | | - `git fetch https://github.com/grpc-ecosystem/grpc-gateway master && git reset --hard FETCH_HEAD` |
| 3 | +- [ ] Check if your issue has already been reported (https://github.com/grpc-ecosystem/grpc-gateway/issues). |
| 4 | +- [ ] Update your protoc to the [latest version](https://github.com/google/protobuf/releases). |
| 5 | +- [ ] Update your copy of the `grpc-gateway` library to the latest version from github: |
| 6 | + ```sh |
| 7 | + go get -u github.com/grpc-ecosystem/grpc-gateway |
| 8 | + ``` |
7 | 9 | - [ ] Delete the `protoc-gen-grpc-gateway` and `protoc-gen-swagger` binary from your `PATH`, |
8 | | - and install locally built binaries. |
| 10 | + and reinstall the latest versions: |
| 11 | + ```sh |
| 12 | + go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway |
| 13 | + go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger |
| 14 | + ``` |
| 15 | + |
| 16 | +## I still have a problem! |
| 17 | + |
| 18 | +Please consider reaching out for help on a chat forum, such as |
| 19 | +[Gophers Slack](https://invite.slack.golangbridge.org/) (channel #grpc-gateway). |
| 20 | +It's much easier to help with common debugging steps in a chat, and some of |
| 21 | +the maintainers are reading the channel regularly. If you |
| 22 | +submit an issue which is clearly an environment setup problem, or it's obvious |
| 23 | +you haven't tried seeking help somewhere else first, we may close your issue. |
| 24 | + |
| 25 | +## I still have a problem! |
| 26 | + |
| 27 | +Please follow these steps to submit a bug report: |
9 | 28 |
|
10 | 29 | ### Bug reports: |
11 | 30 |
|
12 | 31 | Fill in the following sections with explanations of what's gone wrong. |
13 | 32 |
|
14 | | -Steps you follow to reproduce the error: |
| 33 | +### Steps you follow to reproduce the error: |
15 | 34 |
|
| 35 | +```html |
16 | 36 | <!-- Example steps |
17 | 37 | 1. I grab my catapult |
18 | 38 | 2. I load it with lettuce |
19 | 39 | 3. Press the fire button |
20 | 40 | 4. It falls over |
21 | 41 | --> |
| 42 | +``` |
22 | 43 |
|
23 | 44 | Your steps here. |
24 | 45 |
|
25 | | -What did you expect to happen instead: |
| 46 | +### What did you expect to happen instead: |
26 | 47 |
|
| 48 | +```html |
27 | 49 | <!-- Example answer |
28 | 50 | 1. It would have rained lettuce from the sky bringing forth a cuddly army of bunnies we could |
29 | 51 | play with |
30 | 52 | --> |
| 53 | +``` |
31 | 54 |
|
32 | 55 | Your answer here. |
33 | 56 |
|
34 | | -What's your theory on why it isn't working: |
| 57 | +### What's your theory on why it isn't working: |
35 | 58 |
|
| 59 | +```html |
36 | 60 | <!-- Example answer |
37 | 61 | Evil wizards are hoarding the bunnies and don't want to share. The wizards are casting |
38 | 62 | lettuce protection spells so the cattapult won't work. |
39 | 63 | --> |
| 64 | +``` |
40 | 65 |
|
41 | 66 | Your theory here. |
0 commit comments