From 1f323cf9795bef5fb5861ef299015af3eedb8ae9 Mon Sep 17 00:00:00 2001 From: Nick Fitzgerald Date: Wed, 5 Jul 2017 15:00:07 -0700 Subject: [PATCH] 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. --- .github/ISSUE_TEMPLATE.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index c10fab0f7b..02fe3cdec5 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