Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

Update issue templates - add general bug report

kilacodae1adf6aa97ab
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 000000000..03304b3c2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,78 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: " [BUG-General] "
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+<!-- A clear and concise description of what the bug is. -->
+
+**To Reproduce**
+<!-- Provide the problematic code in the code block below -->
+<details><summary>Problematic Code</summary>
+
+```py
+Paste your code here.
+```
+
+</details>
+
+**Expected behavior**
+<!-- A clear and concise description of what you expected to happen. -->
+
+**Output Media Files**
+<!-- 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. -->
+
+<details><summary>Images/GIFs</summary>
+
+<!-- PASTE MEDIA HERE -->
+
+</details>
+
+**Logs**
+<details><summary>Terminal output (Screenshots acceptable)</summary>
+
+```
+PASTE HERE OR REMOVE IF PROVIDING SCREENSHOT
+```
+
+<!-- Paste screenshot here -->
+
+</details>
+
+**System Specifications**
+
+<details><summary>System Details</summary>
+
+- OS (with version, e.g Windows 10 v2004 or macOS 10.15 (Catalina)):
+- RAM:
+- Python version (`python/py/python3 --version`):
+- Installed modules (provide output from `pip list`):
+```
+PASTE HERE
+```
+
+</details>
+
+<details>
+<summary>Latex details</summary>
+
++ Distribution (e.g. TeX Live 2020):
+
+<!-- output of `tlmgr list --only-installed` for TeX Live or a screenshot of the Packkages page for MikTeX -->
++ Installed packages:
+</details>
+
+<details><summary>FFMPEG</summary>
+Output of `ffmpeg -version`:
+
+```
+PASTE HERE
+```
+</details>
+
+**Additional context**
+Add any other context about the problem here.