Skip to content

Commit 068b94d

Browse files
authored
Add GitHub issue templates and TROUBLESHOOTING.md (grpc#568)
1 parent dfe7be7 commit 068b94d

File tree

4 files changed

+105
-0
lines changed

4 files changed

+105
-0
lines changed
+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Ask a question
3+
about: Ask a question related to this project
4+
labels: question
5+
6+
---
7+
8+
<!--
9+
10+
Your question may have already been answered. Please look here first:
11+
- Documentation: https://docs.microsoft.com/aspnet/core/grpc
12+
- Troubleshooting: https://docs.microsoft.com/aspnet/core/grpc/troubleshoot
13+
- StackOverflow, with "grpc" tag: https://stackoverflow.com/questions/tagged/grpc
14+
15+
Issues specific to Grpc.Core (C-core server and client), or code generation with Grpc.Tools should be created at https://github.com/grpc/grpc/issues/new
16+
17+
Make sure you include information that can help us understand your question.
18+
-->
19+
20+
<!-- Your question below this line. -->

.github/ISSUE_TEMPLATE/bug_report.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Report a bug
3+
about: Create a report to help us improve
4+
labels: bug
5+
6+
---
7+
8+
<!--
9+
10+
This form is for bug reports and feature requests ONLY!
11+
For general questions and troubleshooting, please ask/look for answers here:
12+
- Documentation: https://docs.microsoft.com/aspnet/core/grpc
13+
- Troubleshooting: https://docs.microsoft.com/aspnet/core/grpc/troubleshoot
14+
- StackOverflow, with "grpc" tag: https://stackoverflow.com/questions/tagged/grpc
15+
16+
Issues specific to Grpc.Core (C-core server and client), or code generation with Grpc.Tools should be created at https://github.com/grpc/grpc/issues/new
17+
-->
18+
19+
### What version of gRPC and what language are you using?
20+
21+
22+
### What operating system (Linux, Windows,...) and version?
23+
24+
25+
### What runtime / compiler are you using (e.g. .NET Core SDK version `dotnet --info`)
26+
27+
28+
### What did you do?
29+
If possible, provide a recipe for reproducing the error. Try being specific and include code snippets if helpful.
30+
31+
### What did you expect to see?
32+
33+
34+
### What did you see instead?
35+
36+
Make sure you include information that can help us debug (full error message, exception listing, stack trace, logs).
37+
38+
See [TROUBLESHOOTING.md](https://github.com/grpc/grpc-dotnet/blob/master/TROUBLESHOOTING.md) for how to diagnose problems better.
39+
40+
### Anything else we should know about your project / environment?
+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Request a feature
3+
about: Suggest an idea for this project
4+
labels: enhancement
5+
6+
---
7+
8+
<!--
9+
10+
This form is for bug reports and feature requests ONLY!
11+
For general questions and troubleshooting, please ask/look for answers here:
12+
- Documentation: https://docs.microsoft.com/aspnet/core/grpc
13+
- Troubleshooting: https://docs.microsoft.com/aspnet/core/grpc/troubleshoot
14+
- StackOverflow, with "grpc" tag: https://stackoverflow.com/questions/tagged/grpc
15+
16+
Issues specific to Grpc.Core (C-core server and client), or code generation with Grpc.Tools should be created at https://github.com/grpc/grpc/issues/new
17+
-->
18+
19+
### Is your feature request related to a problem? Please describe.
20+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
21+
22+
### Describe the solution you'd like
23+
A clear and concise description of what you want to happen.
24+
25+
### Describe alternatives you've considered
26+
A clear and concise description of any alternative solutions or features you've considered.
27+
28+
### Additional context
29+
Add any other context about the feature request here.

TROUBLESHOOTING.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Troubleshooting gRPC for .NET
2+
3+
This guide is for troubleshooting gRPC for .NET (grpc-dotnet). For issues specific to Grpc.Core (C-core server and client), or code generation with Grpc.Tools, please refer to [TROUBLESHOOTING.md](https://github.com/grpc/grpc/blob/master/TROUBLESHOOTING.md) in `grpc/grpc` repository.
4+
5+
## Troubleshooting documentation
6+
7+
For solutions for commonly encountered problems, see [gRPC troubleshooting](https://docs.microsoft.com/aspnet/core/grpc/troubleshoot).
8+
9+
## Answers on StackOverflow
10+
11+
Your problem might have already been solved on StackOverflow. Search for questions with "grpc" tag: https://stackoverflow.com/questions/tagged/grpc
12+
13+
## Enabling extra logging and tracing
14+
15+
Extra logging can be very useful for diagnosing problems. For documentation on configuring logging in gRPC services and clients, see
16+
[Logging and diagnostics in gRPC on .NET](https://docs.microsoft.com/aspnet/core/grpc/diagnostics).

0 commit comments

Comments
 (0)