diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000..423cdae --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,34 @@ +--- +name: Bug +about: Create a report to help improve the project's infrastructure +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. +A bug should describe an infrastructure problem, for example: LaTeX reports an error, the virtualized environment fails etc. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Environment (please complete the following information):** + - OS: [e.g. iOS] +- Virtualization [e.g. None or Docker] + - LaTeX distribution [e.g. TexLive] + - Document version [e.g. 13.0.10.8.13] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/suggestion.md b/.github/ISSUE_TEMPLATE/suggestion.md new file mode 100644 index 0000000..c0ca30f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/suggestion.md @@ -0,0 +1,26 @@ +--- +name: Suggestion +about: Create a suggestion to improve and enhance the document itself +title: '' +labels: enhancement +assignees: '' + +--- + +**Describe the suggestion** +A short summary what kind of content you'd like to change. + +**Changes in existing chapter ABC** +Either refer to the PDF page number or the chapter you'd like to address. +Cite the original text and add your comments or changes below it. + +**New text, new chapter etc.** +If you'd like to see a new chapter with some more exiting content, great! +Please write down what kind of chapter you think could help improving the project. +Any kind of suggestion, like keywords, notes or even prewritten texts would be of great help here. +Please add also where inside the document the new chapter should be arranged. + +**Scientific sources** +If you can, please add a scientific source like a paper, book or some other kind of source. +This helps to decide how the suggestion can be integrated. +It might be useful to provide the source if necessary so that a reviewer can understand the suggestion and act upon it.