Skip to content

Commit e1adf6a

Browse files
authored
Update issue templates - add general bug report
This template is meant to cover most non-specific issues such as broken code and "something's not working" types of cases. Templates specific to other things such as scene caching and the config system etc. will be added soon.
1 parent 129b3bf commit e1adf6a

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: " [BUG-General] "
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
<!-- A clear and concise description of what the bug is. -->
12+
13+
**To Reproduce**
14+
<!-- Provide the problematic code in the code block below -->
15+
<details><summary>Problematic Code</summary>
16+
17+
```py
18+
Paste your code here.
19+
```
20+
21+
</details>
22+
23+
**Expected behavior**
24+
<!-- A clear and concise description of what you expected to happen. -->
25+
26+
**Output Media Files**
27+
<!-- Paste in the files manim produced on rendering the code above. Note that GitHub doesn't allow posting videos, so you may need to convert it to a GIF or use the `-i` rendering option. -->
28+
29+
<details><summary>Images/GIFs</summary>
30+
31+
<!-- PASTE MEDIA HERE -->
32+
33+
</details>
34+
35+
**Logs**
36+
<details><summary>Terminal output (Screenshots acceptable)</summary>
37+
38+
```
39+
PASTE HERE OR REMOVE IF PROVIDING SCREENSHOT
40+
```
41+
42+
<!-- Paste screenshot here -->
43+
44+
</details>
45+
46+
**System Specifications**
47+
48+
<details><summary>System Details</summary>
49+
50+
- OS (with version, e.g Windows 10 v2004 or macOS 10.15 (Catalina)):
51+
- RAM:
52+
- Python version (`python/py/python3 --version`):
53+
- Installed modules (provide output from `pip list`):
54+
```
55+
PASTE HERE
56+
```
57+
58+
</details>
59+
60+
<details>
61+
<summary>Latex details</summary>
62+
63+
+ Distribution (e.g. TeX Live 2020):
64+
65+
<!-- output of `tlmgr list --only-installed` for TeX Live or a screenshot of the Packkages page for MikTeX -->
66+
+ Installed packages:
67+
</details>
68+
69+
<details><summary>FFMPEG</summary>
70+
Output of `ffmpeg -version`:
71+
72+
```
73+
PASTE HERE
74+
```
75+
</details>
76+
77+
**Additional context**
78+
Add any other context about the problem here.

0 commit comments

Comments
 (0)