Skip to content

Commit 97be024

Browse files
glbrnttglbrntt
authored
Update GitHub issue templates (#812)
* Update GitHub issue templates * Add suggestions
1 parent 860d035 commit 97be024

File tree

3 files changed

+72
-65
lines changed

3 files changed

+72
-65
lines changed

‎.github/ISSUE_TEMPLATE/BUG_REPORT.md

Lines changed: 24 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,39 @@
11
---
22
name: 🐛 Bug Report
33
about: If something isn't working as expected 🤔
4-
4+
labels: bug, nio
55
---
66

7-
<!-- 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]) -->
8-
9-
### New Issue Checklist
7+
<!--
8+
Please check the README, docs/ directory and other issues before filing an issue.
109
11-
- [ ] Updated grpc-swift *and protoc-gen-swiftgrpc* to the latest version
12-
- [ ] I read the [Contribution Guidelines](https://github.com/grpc/grpc-swift/blob/master/CONTRIBUTING.md)
13-
- [ ] 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))
10+
This form is for submitting BUG REPORTS only.
1411
15-
### Issue Description
16-
<!-- Please include what's happening, expected behavior, and any relevant code samples.
17-
Please wrap log statements and code in triple backticks (```) so they get printed correctly on GitHub.
12+
For troubleshooting or new feature requests please use one of the other templates.
1813
-->
1914

20-
##### Complete output when running grpc-swift, including the stack trace and command used
21-
<!-- You can use environment variables for debug
22-
e.g.
23-
export GRPC_TRACE=all
24-
export GRPC_VERBOSITY="DEBUG"
25-
-->
15+
### Describe the bug
16+
17+
Describe the bug as clearly and as concisely as you can. Without enough
18+
information, we will not be able to help you.
19+
20+
Include the version of `grpc-swift` and `protoc-gen-grpc-swift` you are using
21+
(or the Podspec version if you are using CocoaPods) as well as the platform(s)
22+
on which you experienced the bug.
2623

27-
<!-- 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 -->
24+
### To reproduce
2825

29-
<details>
30-
<pre>[INSERT OUTPUT HERE]</pre>
31-
</details>
26+
Steps to reproduce the bug you've found:
27+
1. Set compression to ...
28+
2. Make a bidirectional RPC to ...
29+
3. ...
3230

33-
### Environment
31+
### Expected behaviour
3432

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

37-
<details>
38-
<pre>
39-
40-
| Key | Value |
41-
| ----------------------------- | --------------------------------------------------------------|
42-
| OS Version | x.x.x |
43-
| Swift Version | x.x.x |
44-
| Xcode Version | x.x.x |
45-
| gRPC-Swift Version | x.x.x |
46-
| protoc Version | x.x.x |
47-
| protoc-gen-swift Version | x.x.x |
48-
| protoc-gen-swiftgrpc Version | x.x.x |
49-
</pre>
50-
</details>
35+
### Additional information
5136

37+
Include any information that you think might help us to diagnose and resolve
38+
this more quickly, such as logs, code snippets, or similar cases where the bug
39+
does not reproduce. (Please wrap code snippets and logs in backticks though!)

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: 🚀 Feature Request
3+
about: Suggest an idea to improve gRPC Swift
4+
labels: enhancement, nio
5+
---
6+
7+
<!--
8+
Please check the README, docs/ directory and other issues before filing a new
9+
issue.
10+
11+
This form is for submitting FEATURE REQUESTS or ENHANCEMENTS only.
12+
13+
For bug reports or troubleshooting please use one of the other templates.
14+
-->
15+
16+
17+
### Is your feature request related to a problem? Please describe it.
18+
19+
A clear and concise description of what the problem is. E.g. It's difficult
20+
to ...
21+
22+
### Describe the solution you'd like
23+
24+
A clear and concise description of what you want to happen.
25+
26+
### Describe alternatives you've considered
27+
28+
A clear and concise description of any alternative solutions or features you've
29+
considered, if any.
30+
31+
### Additional context
32+
33+
Add any other context about the feature request here.

‎.github/ISSUE_TEMPLATE/QUESTION.md

Lines changed: 15 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,25 @@
11
---
22
name: ❓ Support Question
3-
about: Not sure how something works or how to implement some functionality? Ask us here! (But please check the README or issues first 🙃)
3+
about: Not sure how something works? Ask us here. (But please check the README and issues first 🙃.)
4+
labels: question, nio
45
---
56

6-
### Question Checklist
7+
<!--
8+
Please check the README, docs/ directory and other issues before filing an issue.
79
8-
- [ ] Updated grpc-swift *and protoc-gen-swiftgrpc* to the latest version
9-
- [ ] I read the [Contribution Guidelines](https://github.com/grpc/grpc-swift/blob/master/CONTRIBUTING.md)
10-
- [ ] I read [README](https://github.com/grpc/grpc-swift/blob/master/README.md)
11-
- [ ] 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))
10+
This form is for submitting QUESTIONS only.
1211
13-
### Question Subject
14-
<!-- Is this a question about documentation? -->
15-
<!-- Is this a question about a third party plugin? (If so, please go to the plugin repository first) -->
12+
For bug reports or new feature requests please use one of the other templates.
13+
-->
1614

17-
#### Question Description
18-
<!-- Please include expected behavior and any relevant code samples with your question if possible -->
19-
<!-- Please wrap log statements and code in triple backticks (```) so they get printed correctly on GitHub. -->
15+
### What are you trying to achieve?
2016

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

22-
### Environment
21+
### What have you tried so far?
2322

24-
<!-- If you are encountering issues, please provide your environment below. This is important to help you. -->
25-
26-
<details>
27-
<pre>
28-
29-
| Key | Value |
30-
| ----------------------------- | --------------------------------------------------------------|
31-
| OS Version | x.x.x |
32-
| Swift Version | x.x.x |
33-
| Xcode Version | x.x.x |
34-
| gRPC-Swift Version | x.x.x |
35-
| protoc Version | x.x.x |
36-
| protoc-gen-swift Version | x.x.x |
37-
| protoc-gen-swiftgrpc Version | x.x.x |
38-
</pre>
39-
</details>
23+
Describe what you've tried to do so far to solve your problem. Include any
24+
relevant information such as the library and protoc plugin versions and any
25+
logs or error messages.

0 commit comments

Comments
 (0)