...

Text file src/github.com/grpc-ecosystem/grpc-gateway/.github/ISSUE_TEMPLATE.md

Documentation: github.com/grpc-ecosystem/grpc-gateway/.github

     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 
    18Please consider reaching out for help on a chat forum, such as
    19[Gophers Slack](https://invite.slack.golangbridge.org/) (channel #grpc-gateway).
    20It's much easier to help with common debugging steps in a chat, and some of
    21the maintainers are reading the channel regularly. If you
    22submit an issue which is clearly an environment setup problem, or it's obvious
    23you haven't tried seeking help somewhere else first, we may close your issue.
    24 
    25## I still have a problem!
    26
    27Please follow these steps to submit a bug report:
    28
    29### Bug reports:
    30
    31Fill 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
    371.  I grab my catapult
    382.  I load it with lettuce
    393.  Press the fire button
    404.  It falls over
    41-->
    42```
    43
    44Your steps here.
    45
    46### What did you expect to happen instead:
    47
    48```html
    49<!-- Example answer
    501.  It would have rained lettuce from the sky bringing forth a cuddly army of bunnies we could
    51    play with
    52-->
    53```
    54
    55Your answer here.
    56
    57### What's your theory on why it isn't working:
    58
    59```html
    60<!-- Example answer
    61Evil wizards are hoarding the bunnies and don't want to share. The wizards are casting 
    62lettuce protection spells so the catapult won't work.
    63-->
    64```
    65
    66Your theory here.

View as plain text