Browse Source

Update our issue templates (#806)

* Update our issue templates

Motivation: A bunch of recent issues due to version mismatches between library and protoc plugin could have become obvious when entering the version list..

* Update BUG_REPORT.md
Daniel Alm 5 years ago
parent
commit
9a41c8efda
2 changed files with 24 additions and 5 deletions
  1. 2 3
      .github/ISSUE_TEMPLATE/BUG_REPORT.md
  2. 22 2
      .github/ISSUE_TEMPLATE/QUESTION.md

+ 2 - 3
.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -8,7 +8,7 @@ about: If something isn't working as expected 🤔
 
 ### New Issue Checklist
 
-- [ ] Updated grpc-swift to the latest version
+- [ ] Updated grpc-swift *and protoc-gen-swiftgrpc* to the latest version
 - [ ] I read the [Contribution Guidelines](https://github.com/grpc/grpc-swift/blob/master/CONTRIBUTING.md)
 - [ ] I searched for [existing GitHub issues](https://github.com/grpc/grpc-swift/issues)(especially, there are many [resolved issues related to SSL](https://github.com/grpc/grpc-swift/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aclosed+ssl))
 
@@ -32,7 +32,7 @@ export GRPC_VERBOSITY="DEBUG"
 
 ### Environment
 
-<!-- Please input your environment. -->
+<!-- Please provide your environment below. This is important to help you. -->
 
 <details>
   <pre>
@@ -43,7 +43,6 @@ export GRPC_VERBOSITY="DEBUG"
 | Swift Version                 |   x.x.x                                                       |
 | Xcode Version                 |   x.x.x                                                       |
 | gRPC-Swift Version            |   x.x.x                                                       |
-| gRPC-Swift Version            |   x.x.x                                                       |
 | protoc Version                |   x.x.x                                                       |
 | protoc-gen-swift Version      |   x.x.x                                                       |
 | protoc-gen-swiftgrpc Version  |   x.x.x                                                       |

+ 22 - 2
.github/ISSUE_TEMPLATE/QUESTION.md

@@ -5,7 +5,7 @@ about: Not sure how something works or how to implement some functionality? Ask
 
 ### Question Checklist
 
-- [ ] Updated grpc-swift to the latest version
+- [ ] Updated grpc-swift *and protoc-gen-swiftgrpc* to the latest version
 - [ ] I read the [Contribution Guidelines](https://github.com/grpc/grpc-swift/blob/master/CONTRIBUTING.md)
 - [ ] I read [README](https://github.com/grpc/grpc-swift/blob/master/README.md)
 - [ ] I searched for [existing GitHub issues](https://github.com/grpc/grpc-swift/issues) (especially, there are many [resolved issues related to SSL](https://github.com/grpc/grpc-swift/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aclosed+ssl))
@@ -16,4 +16,24 @@ about: Not sure how something works or how to implement some functionality? Ask
 
 #### Question Description
 <!-- Please include expected behavior and any relevant code samples with your question if possible -->
-<!-- Please wrap log statements and code in triple backticks (```) so they get printed correctly on GitHub. -->
+<!-- Please wrap log statements and code in triple backticks (```) so they get printed correctly on GitHub. -->
+
+
+### Environment
+
+<!-- If you are encountering issues, please provide your environment below. This is important to help you. -->
+
+<details>
+  <pre>
+  
+| Key                           | Value                                                         |
+| ----------------------------- | --------------------------------------------------------------|
+| OS Version                    |   x.x.x                                                       |
+| Swift Version                 |   x.x.x                                                       |
+| Xcode Version                 |   x.x.x                                                       |
+| gRPC-Swift Version            |   x.x.x                                                       |
+| protoc Version                |   x.x.x                                                       |
+| protoc-gen-swift Version      |   x.x.x                                                       |
+| protoc-gen-swiftgrpc Version  |   x.x.x                                                       |
+  </pre>
+</details>