From 23f3c1c0f0bc271b39b300e75a74905d1cfd9a2b Mon Sep 17 00:00:00 2001 From: Frank Mittelbach Date: Sat, 11 Nov 2017 20:25:54 +0100 Subject: [PATCH] some suggested changes to the template [ci skip] --- ISSUE_TEMPLATE.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 8f883adbe..cd2df887c 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -9,19 +9,23 @@ Please replace this line with a brief summary of your issue. To check that you are really seeing a bug, please write a short, self-contained document that shows the problem. This should include the `latexbug` package, -which will warn if you are using any third-party packages or document classes. +which will warn if your test file is not suitable for one or the other reason. +See CONTRIBUTING for details and also if you need to obtain the package. + If the bug turns out to be with third-party software then please contact the developer, and not us! ```latex -\RequirePackage{latexbug} +\RequirePackage{latexbug} % <--should be always the first line! \documentclass{article} \begin{document} % Demonstration of issue here \end{document} ``` -## Log file +## Log (and possibly PDF) file Once you have constructed a minimal example, run LaTeX on *exactly* that input -and check that `latexbug` doesn't pick up any third-party files. If all looks -good, attach the `.log` file by dragging-and-dropping onto the issue report. \ No newline at end of file +and check that `latexbug` doesn't report any problems. If all looks +good, attach the `.log` file by dragging-and-dropping it onto the issue report. + +In some cases it may also be helpful to attach the resulting .pdf file. \ No newline at end of file