Skip to content

Commit 050d8da

Browse files
authored
Add Pull Request Template (#1366)
* added PULL_REQUEST_TEMPLATE.md * moved ISSUE_TEMPLATE and ISSUE_TEMPLATE to .github * moved PULL_REQUEST_TEMPLATE.md file to .github
1 parent 554b3da commit 050d8da

File tree

2 files changed

+90
-0
lines changed

2 files changed

+90
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# The gRPC-Gateway project is maintained by volunteers in their spare time. Please follow these troubleshooting steps before submitting an issue.
2+
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+
```
9+
- [ ] Delete the `protoc-gen-grpc-gateway` and `protoc-gen-swagger` binary from your `PATH`,
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:
28+
29+
### Bug reports:
30+
31+
Fill in the following sections with explanations of what's gone wrong.
32+
33+
### Steps you follow to reproduce the error:
34+
35+
```html
36+
<!-- Example steps
37+
1. I grab my catapult
38+
2. I load it with lettuce
39+
3. Press the fire button
40+
4. It falls over
41+
-->
42+
```
43+
44+
Your steps here.
45+
46+
### What did you expect to happen instead:
47+
48+
```html
49+
<!-- Example answer
50+
1. It would have rained lettuce from the sky bringing forth a cuddly army of bunnies we could
51+
play with
52+
-->
53+
```
54+
55+
Your answer here.
56+
57+
### What's your theory on why it isn't working:
58+
59+
```html
60+
<!-- Example answer
61+
Evil wizards are hoarding the bunnies and don't want to share. The wizards are casting
62+
lettuce protection spells so the catapult won't work.
63+
-->
64+
```
65+
66+
Your theory here.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!--
2+
Thank you for sending the PR! We appreciate you spending the time to work on these changes.
3+
4+
Help us understand your motivation by explaining why you decided to make this change.
5+
6+
You can learn more about contributing to grpc-gateway here: https://github.com/grpc-ecosystem/grpc-gateway/blob/master/CONTRIBUTING.md
7+
8+
Happy contributing!
9+
10+
-->
11+
12+
#### References to other Issues or PRs
13+
14+
<!-- If this pull request fixes an issue, write "Fixes #NNNN" in that exact
15+
format, e.g. "Fixes #1234" (see
16+
https://tinyurl.com/auto-closing for more information). Also, please
17+
write a comment on that issue linking back to this pull request once it is
18+
open. -->
19+
20+
#### Have you read the [Contributing Guidelines](https://github.com/grpc-ecosystem/grpc-gateway/blob/master/CONTRIBUTING.md)?
21+
22+
#### Brief description of what is fixed or changed
23+
24+
#### Other comments

0 commit comments

Comments
 (0)