Merge pull request #194 from AlexanderZeilmann/master

Update bug & feature request templates

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,43 +1,38 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-
 ---
 
-
+<!--
 ### Prerequisites
 
-* [ ] Put an X between the brackets on this line if you have done all of the following:
-    * Check that you are using the latest version of kaobook.
-    * Check that your issue isn't already filed: https://github.com/fmarotta/kaobook/issues
+Before reporting a bug please make sure
+* that you are using the latest version of kaobook,
+* and that your issue isn't already filed: https://github.com/fmarotta/kaobook/issues.
+-->
 
 ### Description
-
-[Description of the issue]
+<!-- Description of the issue -->
 
 ### Minimal Working Example
-[You can use the following document to help you create a minimal working example.]
-```
+<!-- You can use the following document to help you create a minimal working example. -->
+
+```latex
 \documentclass{kaobook}
 \usepackage[english]{babel}
 \usepackage{blindtext}
 \usepackage{kaobiblio}
 \usepackage{kaotheorems}
 \usepackage{kaorefs}
 
-
 \begin{document}
 
 \title{Bug Report}
 \author{Author}
 \date{\today}
 
 \frontmatter
-
-\KOMAoptions{twoside=semi}
 \maketitle
-\KOMAoptions{twoside=false}
-
 \mainmatter
 \setchapterstyle{kao}
 
@@ -47,11 +42,12 @@ about: Create a report to help us improve
 \end{document}
 ```
 
-**Expected behavior:** [What you expect to happen]
+**Expected behavior:**
+<!-- What you expect to happen-->
 
-**Actual behavior:** [What actually happens. Feel free to include the logfile or screenshots of your document]
+**Actual behavior:**
+<!-- What actually happens. Feel free to include the log-file or screenshots of your document-->
 
 
 ### Additional Information
-
-[Any relevant additional information]
+<!-- Any relevant additional information -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,17 +1,13 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-
 ---
 
 ## Summary
-
-[One sentence explanation of the feature.]
+<!-- One sentence explanation of the feature. -->
 
 ## Details
-
-[What exactly should be done? What use cases does it support? What is the expected outcome?]
+<!-- What exactly should be done? What use cases does it support? What is the expected outcome? -->
 
 ## Additional context
-
-[Add any other context or screenshots about the feature request here.]
+<!-- Add any other context or screenshots about the feature request here. -->