Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

New issue templates (#708)

Benjamin Hackle247b7cc0bc7
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index d83c3d2d4..000000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,14 +0,0 @@
-### If this is a support request:
-
-**Please attempt to solve the problem on your own before opening an issue.**
-Between old issues, StackOverflow, and Google, you should be able to find
-solutions to most of the common problems.
-
-Include at least:
-1. Steps to reproduce the issue (e.g. the command you ran)
-2. The unexpected behavior that occurred (e.g. error messages or screenshots)
-3. The environment (e.g. operating system and version of manim)
-
-
-### If this is a feature request:
-Include the motivation for making this change.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 03304b3c2..237d2ac9f 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,18 +1,24 @@
---
-name: Bug report
-about: Create a report to help us improve
-title: " [BUG-General] "
+name: Manim bug
+about: Report a bug or unexpected behavior when running Manim
+title: ""
labels: bug
assignees: ''
---
-**Describe the bug**
-<!-- A clear and concise description of what the bug is. -->
+## Description of bug / unexpected behavior
+<!-- Add a clear and concise description of the problem you encountered. -->
-**To Reproduce**
-<!-- Provide the problematic code in the code block below -->
-<details><summary>Problematic Code</summary>
+
+## Expected behavior
+<!-- Add a clear and concise description of what you expected to happen. -->
+
+
+## How to reproduce the issue
+<!-- Provide a piece of code illustrating the undesired behavior. -->
+
+<details><summary>Code for reproducing the problem</summary>
```py
Paste your code here.
@@ -20,10 +26,8 @@ Paste your code here.
</details>
-**Expected behavior**
-<!-- A clear and concise description of what you expected to happen. -->
-**Output Media Files**
+## Additional 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>
@@ -32,41 +36,42 @@ Paste your code here.
</details>
-**Logs**
-<details><summary>Terminal output (Screenshots acceptable)</summary>
+
+## Logs
+<details><summary>Terminal output</summary>
+<!-- Add "-v DEBUG" when calling manim to generate more detailed logs -->
```
-PASTE HERE OR REMOVE IF PROVIDING SCREENSHOT
+PASTE HERE OR PROVIDE LINK TO https://pastebin.com/ OR SIMILAR
```
-<!-- Paste screenshot here -->
+<!-- Insert screenshots here (only when absolutely necessary, we prefer copy/pasted output!) -->
</details>
-**System Specifications**
+
+## System specifications
<details><summary>System Details</summary>
-- OS (with version, e.g Windows 10 v2004 or macOS 10.15 (Catalina)):
-- RAM:
+- 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>
+<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:
++ LaTeX distribution (e.g. TeX Live 2020):
++ Installed LaTeX packages:
+<!-- output of `tlmgr list --only-installed` for TeX Live or a screenshot of the Packages page for MikTeX -->
</details>
<details><summary>FFMPEG</summary>
+
Output of `ffmpeg -version`:
```
@@ -74,5 +79,5 @@ PASTE HERE
```
</details>
-**Additional context**
-Add any other context about the problem here.
+## Additional comments
+<!-- Add further context that you think might be relevant for this issue here. -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 000000000..67f641ada
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Request a new feature for Manim
+title: ""
+labels: new feature
+assignees: ''
+
+---
+
+## Description of proposed feature
+<!-- Add a clear and concise description of the new feature, including a motivation: why do you think this will be useful? -->
+
+
+## How can the new feature be used?
+<!-- If possible, illustrate how this new feature could be used. -->
+
+
+## Additional comments
+<!-- Add further context that you think might be relevant. -->
diff --git a/.github/ISSUE_TEMPLATE/installation_issue.md b/.github/ISSUE_TEMPLATE/installation_issue.md
new file mode 100644
index 000000000..3e99354a8
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/installation_issue.md
@@ -0,0 +1,66 @@
+---
+name: Installation issue
+about: Report issues with the installation process of Manim
+title: ""
+labels: bug, installation
+assignees: ''
+
+---
+
+#### Preliminaries
+
+- [ ] I have followed the latest version of the
+ [installation instructions](https://docs.manim.community/en/latest/installation.html).
+- [ ] I have checked the [troubleshooting page](https://docs.manim.community/en/latest/installation/troubleshooting.html) and my problem is either not mentioned there,
+ or the solution given there does not help.
+
+## Description of error
+<!-- Add a clear and concise description of the problem you encountered. -->
+
+
+## Installation logs
+<!-- Please paste the **full** terminal output; we can only help to identify the issue
+ when we receive all required information. -->
+
+<details><summary>Terminal output</summary>
+
+```
+PASTE HERE OR PROVIDE LINK TO https://pastebin.com/ OR SIMILAR
+```
+
+<!-- Insert screenshots here (only when absolutely necessary, we prefer copy/pasted output!) -->
+
+</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>
+
++ LaTeX distribution (e.g. TeX Live 2020):
++ Installed LaTeX packages:
+<!-- output of `tlmgr list --only-installed` for TeX Live or a screenshot of the Packages page for MikTeX -->
+</details>
+
+<details><summary>FFMPEG</summary>
+
+Output of `ffmpeg -version`:
+
+```
+PASTE HERE
+```
+</details>
+
+## Additional comments
+<!-- Add further context that you think might be relevant for this issue here. -->
diff --git a/.github/ISSUE_TEMPLATE/suggestion.md b/.github/ISSUE_TEMPLATE/suggestion.md
new file mode 100644
index 000000000..0d758dd5d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/suggestion.md
@@ -0,0 +1,17 @@
+---
+name: Suggestion
+about: Make a suggestion for the enhancement of existing features
+title: ""
+labels: enhancement
+assignees: ''
+
+---
+
+## Enhancement proposal
+<!-- Add a clear and concise description of your enhancement proposal. In particular,
+ if your enhancement introduces changes to the API, illustrate them with
+ (fictional) code examples. -->
+
+
+## Additional comments
+<!-- Add further context that you think might be relevant. -->