summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Fitzgerald <fitzgen@gmail.com>2017-02-16 11:35:22 -0800
committerNick Fitzgerald <fitzgen@gmail.com>2017-02-17 08:09:00 -0800
commit39391a421ab229d28bb2026cf95f545e71fcdf79 (patch)
treeebaee65661df338906c44f55313751f46de76a55
parente57b2cb3037628abbbf2be549ae3a2e8a4aa95b2 (diff)
Create ISSUE_TEMPLATE.md
Github will automatically fill this in when people file new issues.
-rw-r--r--.github/ISSUE_TEMPLATE.md63
1 files changed, 63 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 00000000..68dfb68e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,63 @@
+### Input C/C++ Header
+
+```C++
+// Insert your (minimal) C/C++ header here
+```
+
+### Bindgen Invokation
+
+<!--
+
+Place either the `bindgen::Builder` **OR** the command line flags used here.
+
+```Rust
+bindgen::Builder::default()
+ .header("input.h")
+ .generate()
+ .unwrap()
+```
+
+OR
+
+```
+$ bindgen input.h --whatever --flags
+```
+
+-->
+
+### Actual Results
+
+<!--
+
+```
+Insert panic message and backtrace here.
+```
+
+and/or
+
+```rust
+// Insert the (incorrect) generated bindings here
+```
+
+and/or
+
+```
+Insert compilation errors generated when compiling the bindings with rustc here
+```
+
+-->
+
+### Expected Results
+
+<!--
+Replace this with a description of what you expected instead of the actual
+results. The more precise, the better! For example, if a struct in the generated
+bindings is missing a field that exists in the C/C++ struct, not that here.
+-->
+
+### `RUST_LOG=bindgen` Output
+
+```
+Insert debug logging when running bindgen with the RUST_LOG=bindgen environment
+variable set.
+```