Skip to content

Commit

Permalink
[#29] Add issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
yax-lakam-tuun authored Apr 26, 2023
1 parent 0b74958 commit 7c33868
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -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.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/suggestion.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 7c33868

Please sign in to comment.