[latex3-commits] [git/latex2e] master: Try short ISSUE template (3ff295b)

Frank Mittelbach frank.mittelbach at latex-project.org
Thu Dec 7 23:51:45 CET 2017


Repository : https://github.com/latex3/latex2e
On branch  : master
Link       : https://github.com/latex3/latex2e/commit/3ff295b32f61cc4e2866635b7eb6d03614959ad5

>---------------------------------------------------------------

commit 3ff295b32f61cc4e2866635b7eb6d03614959ad5
Author: Frank Mittelbach <frank.mittelbach at latex-project.org>
Date:   Thu Dec 7 23:51:45 2017 +0100

    Try short ISSUE template


>---------------------------------------------------------------

3ff295b32f61cc4e2866635b7eb6d03614959ad5
 .github/ISSUE_TEMPLATE.md |   28 +++++++++++++---------------
 1 file changed, 13 insertions(+), 15 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index 8792f22..a413e3d 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,28 +1,26 @@
-Thank you for using Issue Tracker!
-
-*Note: for support questions, please use [StackExchange](http://tex.stackexchange.com) or a similar forum. This repository's issues are reserved for bug reports.*
-
-If the bug is clearly related to some particular package, say `multicol`, we suggest that you use a title line indicating that package, i.e., `multicol: My Issue Title` in that case.
+!! Please fill out all sections after reading CONRIBUTING guidelines !!
 
 ## Brief outline of the bug
 
-Please replace this line with a brief summary of your issue.
-
-## Minimal example
 
-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 your test file is not suitable for one or the other reason. See the `CONTRIBUTING` guide for details and also if you need to obtain the `latexbug` package.
 
-If the bug turns out to be with third-party software then please contact the developer, and not us!
+## Your minimal example showing the bug
 
-```latex
-\RequirePackage{latexbug}     % <--should be always the first line!
+``
+\RequirePackage{latexbug}       % <--should be always the first line (see CONTRIBUTING)!
 \documentclass{article}
+
+  % Any preamble code goes here
+
 \begin{document}
-% Demonstration of issue here
+
+  % Demonstration of issue here
+  
 \end{document}
 ```
+
+
 ## Log (and possibly PDF) file  
 
-Once you have constructed a minimal example, run LaTeX on *exactly* that input 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.
+!! Use drag-and-drop !!
 
-In some cases it may also be helpful to attach the resulting `.pdf` file.
\ No newline at end of file





More information about the latex3-commits mailing list