Skip to content

Commit 6c809d6

Browse files
committed
Add an issue template
1 parent 173c5be commit 6c809d6

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

.github/issue_template.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
**Help us help you.**
2+
3+
If you are reporting a bug, include:
4+
5+
* a Minimum Working Example without any dependencies (except libc) that shows
6+
the issue and ideally reproduces in the Rust playground
7+
* the target triple - libc supports many targets and many APIs
8+
* instructions to reproduce, logs (e.g. build logs, links to Travis-CI logs,
9+
uploads to github gists, etc.).
10+
11+
If you are requesting a new API, include:
12+
13+
* the target triple
14+
* link to the documentation of the API showing the type signatures, how to use
15+
it, etc.
16+
17+
In general, just please consider that the people who can help you are all very
18+
busy, they will be helping you in their free time, there are a lot of people in
19+
need of help so they need to prioritize to which issues they devote their free
20+
time, etc. So try to give most of the information upfront, be concise, show
21+
small self-contained examples (nobody has time to create a new cargo project,
22+
set up dependencies,...), etc. Help us help you.

0 commit comments

Comments
 (0)