Skip to content

Update GitHub issue templates #812

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 29, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 24 additions & 36 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,39 @@
---
name: 🐛 Bug Report
about: If something isn't working as expected 🤔

labels: bug, nio
---

<!-- Thanks for helping grpc-swift! Before you submit your issue, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->

### New Issue Checklist
<!--
Please check the README, docs/ directory and other issues before filing an issue.

- [ ] 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))
This form is for submitting BUG REPORTS only.

### Issue Description
<!-- Please include what's happening, expected behavior, and any relevant code samples.
Please wrap log statements and code in triple backticks (```) so they get printed correctly on GitHub.
For troubleshooting or new feature requests please use one of the other templates.
-->

##### Complete output when running grpc-swift, including the stack trace and command used
<!-- You can use environment variables for debug
e.g.
export GRPC_TRACE=all
export GRPC_VERBOSITY="DEBUG"
-->
### Describe the bug

Describe the bug as clearly and as concisely as you can. Without enough
information, we will not be able to help you.

Include the version of `grpc-swift` and `protoc-gen-grpc-swift` you are using
(or the Podspec version if you are using CocoaPods) as well as the platform(s)
on which you experienced the bug.

<!-- The output of `GRPC_VERBOSITY` could contain sensitive data, Please make sure you double check the output and replace anything sensitive you don't wish to submit in the issue -->
### To reproduce

<details>
<pre>[INSERT OUTPUT HERE]</pre>
</details>
Steps to reproduce the bug you've found:
1. Set compression to ...
2. Make a bidirectional RPC to ...
3. ...

### Environment
### Expected behaviour

<!-- Please provide your environment below. This is important to help you. -->
Describe what you expect to happen when the steps above are followed.

<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>
### Additional information

Include any information that you think might help us to diagnose and resolve
this more quickly, such as logs, code snippets, or similar cases where the bug
does not reproduce. (Please wrap code snippets and logs in backticks though!)
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: 🚀 Feature Request
about: Suggest an idea to improve gRPC Swift
labels: enhancement, nio
---

<!--
Please check the README, docs/ directory and other issues before filing a new
issue.

This form is for submitting FEATURE REQUESTS or ENHANCEMENTS only.

For bug reports or troubleshooting please use one of the other templates.
-->


### Is your feature request related to a problem? Please describe it.

A clear and concise description of what the problem is. E.g. It's difficult
to ...

### Describe the solution you'd like

A clear and concise description of what you want to happen.

### Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've
considered, if any.

### Additional context

Add any other context about the feature request here.
44 changes: 15 additions & 29 deletions .github/ISSUE_TEMPLATE/QUESTION.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,25 @@
---
name: ❓ Support Question
about: Not sure how something works or how to implement some functionality? Ask us here! (But please check the README or issues first 🙃)
about: Not sure how something works? Ask us here. (But please check the README and issues first 🙃.)
labels: question, nio
---

### Question Checklist
<!--
Please check the README, docs/ directory and other issues before filing an issue.

- [ ] 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))
This form is for submitting QUESTIONS only.

### Question Subject
<!-- Is this a question about documentation? -->
<!-- Is this a question about a third party plugin? (If so, please go to the plugin repository first) -->
For bug reports or new feature requests please use one of the other templates.
-->

#### 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. -->
### What are you trying to achieve?

Describe your problem at a high level. Include code snippets if you think that
would help better illustrate your problem. Without enough information, we will
not be able to help you.

### Environment
### What have you tried so far?

<!-- 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>
Describe what you've tried to do so far to solve your problem. Include any
relevant information such as the library and protoc plugin versions and any
logs or error messages.