diff options
| author | Nick Fitzgerald <fitzgen@gmail.com> | 2017-07-05 15:00:07 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-07-05 15:00:07 -0700 |
| commit | 1f323cf9795bef5fb5861ef299015af3eedb8ae9 (patch) | |
| tree | 0153190bc4e0ea1c55c9f89cbdf57c982ad2563e | |
| parent | 78e7546d3be61a7cb7272c7365564300481798ae (diff) | |
Minimal test cases don't have `#include`s
The inclusion of an `#include` means that the test case
* is not minimal, and
* is harder to reproduce the bug with, since not everyone has the same headers (or versions of headers) on their system.
| -rw-r--r-- | .github/ISSUE_TEMPLATE.md | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index c10fab0f..02fe3cde 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,7 +1,14 @@ ### Input C/C++ Header ```C++ -// Insert your (minimal) C/C++ header here. +// Insert your minimal C or C++ header here. +// +// It should *NOT* have any `#include`s! Not all systems have the same header +// files, and therefore any `#include` harms reproducibility. Additionally, +// the test case isn't minimal since the included file almost assuredly +// contains things that aren't necessary to reproduce the bug, and makes +// tracking it down much more difficult. If necessary, see +// https://github.com/servo/rust-bindgen/blob/master/CONTRIBUTING.md#using-creduce-to-minimize-test-cases ``` ### Bindgen Invocation |