Skip to content

Commit 565b481

Browse files
Add more guidance to issue template
1 parent 8558711 commit 565b481

File tree

1 file changed

+34
-9
lines changed

1 file changed

+34
-9
lines changed

ISSUE_TEMPLATE.md

Lines changed: 34 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,66 @@
1+
# The gRPC-Gateway project is maintained by volunteers in their spare time. Please follow these troubleshooting steps before submitting an issue.
12

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+
```
79
- [ ] 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:
928

1029
### Bug reports:
1130

1231
Fill in the following sections with explanations of what's gone wrong.
1332

14-
Steps you follow to reproduce the error:
33+
### Steps you follow to reproduce the error:
1534

35+
```html
1636
<!-- Example steps
1737
1. I grab my catapult
1838
2. I load it with lettuce
1939
3. Press the fire button
2040
4. It falls over
2141
-->
42+
```
2243

2344
Your steps here.
2445

25-
What did you expect to happen instead:
46+
### What did you expect to happen instead:
2647

48+
```html
2749
<!-- Example answer
2850
1. It would have rained lettuce from the sky bringing forth a cuddly army of bunnies we could
2951
play with
3052
-->
53+
```
3154

3255
Your answer here.
3356

34-
What's your theory on why it isn't working:
57+
### What's your theory on why it isn't working:
3558

59+
```html
3660
<!-- Example answer
3761
Evil wizards are hoarding the bunnies and don't want to share. The wizards are casting
3862
lettuce protection spells so the cattapult won't work.
3963
-->
64+
```
4065

4166
Your theory here.

0 commit comments

Comments
 (0)