From 565b48109c5aa4c467de8873ca28afc91ab56d73 Mon Sep 17 00:00:00 2001 From: Johan Brandhorst Date: Sun, 9 Sep 2018 14:01:49 +0100 Subject: [PATCH] Add more guidance to issue template --- ISSUE_TEMPLATE.md | 43 ++++++++++++++++++++++++++++++++++--------- 1 file changed, 34 insertions(+), 9 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 9edbaa64c96..e732a82f019 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,41 +1,66 @@ +# The gRPC-Gateway project is maintained by volunteers in their spare time. Please follow these troubleshooting steps before submitting an issue. -# Please follow the general troubleshooting steps first: - -- [ ] Update your protoc to the [latest version](https://github.com/google/protobuf/releases) -- [ ] Update your copy of `grpc-gateway` to the latest version from github. with - `git fetch https://github.com/grpc-ecosystem/grpc-gateway master && git reset --hard FETCH_HEAD` +- [ ] Check if your issue has already been reported (https://github.com/grpc-ecosystem/grpc-gateway/issues). +- [ ] Update your protoc to the [latest version](https://github.com/google/protobuf/releases). +- [ ] Update your copy of the `grpc-gateway` library to the latest version from github: + ```sh + go get -u github.com/grpc-ecosystem/grpc-gateway + ``` - [ ] Delete the `protoc-gen-grpc-gateway` and `protoc-gen-swagger` binary from your `PATH`, - and install locally built binaries. + and reinstall the latest versions: + ```sh + go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway + go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger + ``` + +## I still have a problem! + +Please consider reaching out for help on a chat forum, such as +[Gophers Slack](https://invite.slack.golangbridge.org/) (channel #grpc-gateway). +It's much easier to help with common debugging steps in a chat, and some of +the maintainers are reading the channel regularly. If you +submit an issue which is clearly an environment setup problem, or it's obvious +you haven't tried seeking help somewhere else first, we may close your issue. + +## I still have a problem! + +Please follow these steps to submit a bug report: ### Bug reports: Fill in the following sections with explanations of what's gone wrong. -Steps you follow to reproduce the error: +### Steps you follow to reproduce the error: +```html +``` Your steps here. -What did you expect to happen instead: +### What did you expect to happen instead: +```html +``` Your answer here. -What's your theory on why it isn't working: +### What's your theory on why it isn't working: +```html +``` Your theory here.