Skip to content

Commit 1f323cf

Browse files
authored
Minimal test cases don't have #includes
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.
1 parent 78e7546 commit 1f323cf

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

.github/ISSUE_TEMPLATE.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
### Input C/C++ Header
22

33
```C++
4-
// Insert your (minimal) C/C++ header here.
4+
// Insert your minimal C or C++ header here.
5+
//
6+
// It should *NOT* have any `#include`s! Not all systems have the same header
7+
// files, and therefore any `#include` harms reproducibility. Additionally,
8+
// the test case isn't minimal since the included file almost assuredly
9+
// contains things that aren't necessary to reproduce the bug, and makes
10+
// tracking it down much more difficult. If necessary, see
11+
// https://github.com/servo/rust-bindgen/blob/master/CONTRIBUTING.md#using-creduce-to-minimize-test-cases
512
```
613

714
### Bindgen Invocation

0 commit comments

Comments
 (0)