summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorgnzlbg <gonzalobg88@gmail.com>2019-04-02 09:30:14 +0200
committergnzlbg <gonzalobg88@gmail.com>2019-04-02 09:30:14 +0200
commit6c809d6bbcf8936edba17bc49cd489508aeec83e (patch)
tree3dddd8b2644cea4172221ea5825bc789f042f728 /.github
parent173c5be79bc931c6b0d3227aa2133ff34f8a1761 (diff)
downloadrust-libc-6c809d6bbcf8936edba17bc49cd489508aeec83e.tar.gz
Add an issue template
Diffstat (limited to '.github')
-rw-r--r--.github/issue_template.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/.github/issue_template.md b/.github/issue_template.md
new file mode 100644
index 0000000000..a0bd772a88
--- /dev/null
+++ b/.github/issue_template.md
@@ -0,0 +1,22 @@
+**Help us help you.**
+
+If you are reporting a bug, include:
+
+* a Minimum Working Example without any dependencies (except libc) that shows
+ the issue and ideally reproduces in the Rust playground
+* the target triple - libc supports many targets and many APIs
+* instructions to reproduce, logs (e.g. build logs, links to Travis-CI logs,
+ uploads to github gists, etc.).
+
+If you are requesting a new API, include:
+
+* the target triple
+* link to the documentation of the API showing the type signatures, how to use
+ it, etc.
+
+In general, just please consider that the people who can help you are all very
+busy, they will be helping you in their free time, there are a lot of people in
+need of help so they need to prioritize to which issues they devote their free
+time, etc. So try to give most of the information upfront, be concise, show
+small self-contained examples (nobody has time to create a new cargo project,
+set up dependencies,...), etc. Help us help you.