github.com/grpc-ecosystem/grpc-gateway/v2@v2.19.1/.github/ISSUE_TEMPLATE.md (about)

     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 github.com/grpc-ecosystem/grpc-gateway/v2@latest
     8    ```
     9  - [ ] Delete the `protoc-gen-grpc-gateway` and `protoc-gen-openapiv2` binary from your `PATH`, and reinstall the latest versions:
    10  
    11    ```sh
    12    go get github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway
    13    go get github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2
    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.