Skip to content

Commit 9b62b62

Browse files
jeertmansjeertmans
authored
chore(ci): rework issue templates (#456)
* chore(ci): rework issue templates Closes #406 * chore(ci): small fixes * up * add changelog entry
1 parent e2d8c56 commit 9b62b62

File tree

6 files changed

+212
-56
lines changed

6 files changed

+212
-56
lines changed

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 147 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,177 @@
11
name: Bug
22
description: Report an issue to help improve the project.
3+
title: '[BUG] <short-description-here>'
34
labels: bug
4-
title: '[BUG] <description>'
5+
56
body:
7+
- type: markdown
8+
id: preamble
9+
attributes:
10+
value: |
11+
**Thank you for reporting a problem about Manim Slides!**
12+
13+
If you know how to solve your problem, feel free to submit a PR too!
14+
15+
> ![WARNING]
16+
> Before reporting your bug, please make sure to:
17+
>
18+
> 1. create and activate virtual environment (venv);
19+
> 2. install `manim-slides` and the necessary dependencies;
20+
> 3. and reduce your Python to a minimal working example (MWE).
21+
>
22+
> You can skip the last step if your issue occurs during installation.
23+
24+
- type: checkboxes
25+
id: terms
26+
attributes:
27+
label: Terms
28+
description: 'By submitting this issue, I have:'
29+
options:
30+
- label: Checked the [existing issues](https://github.com/jeertmans/manim-slides/issues?q=is%3Aissue+label%3Adocumentation+) and [discussions](https://github.com/jeertmans/manim-slides/discussions) to see if my issue had not already been reported;
31+
required: true
32+
- label: Read the [installation instructions](https://manim-slides.eertmans.be/latest/installation.html);
33+
required: true
34+
- label: Created a virtual environment in which I can reproduce my bug;
35+
636
- type: textarea
737
id: description
838
attributes:
9-
label: Description
10-
description: A brief description of the question or issue, also include what you tried and what didn't work
39+
label: Describe the issue
40+
description: A description of the issue, also include what you tried and what didn't work.
1141
validations:
1242
required: true
43+
1344
- type: textarea
14-
id: version
45+
id: command
1546
attributes:
16-
label: Version
17-
description: Which version of Manim Slides are you using? You can use `manim-slides --version` to get that information.
47+
label: Command
48+
description: |
49+
Enter the command that failed.
50+
This will be automatically formatted into code, so no need for backticks.
51+
render: shell
1852
validations:
1953
required: true
54+
55+
- type: dropdown
56+
id: issue-type
57+
attributes:
58+
label: Issue Type
59+
description: >
60+
Please select the option in the drop-down.
61+
options:
62+
- Installation issue
63+
- Visual bug when presenting (`manim-slides present`)
64+
- Bug when presenting with HTML/PowerPoint/... format (`manim-slides convert`)
65+
- Other
66+
validations:
67+
required: true
68+
69+
- type: textarea
70+
id: py-version
71+
attributes:
72+
label: Python version
73+
description: |
74+
Please copy and paste the output of `python --version`.
75+
Make sure to activate your virtual environment first (if any).
76+
This will be automatically formatted into code, so no need for backticks.
77+
placeholder: Python 3.11.8
78+
render: shell
79+
validations:
80+
required: false
81+
2082
- type: textarea
83+
id: venv
84+
attributes:
85+
label: Python environment
86+
description: |
87+
Please copy and paste the output of `pip freeze`.
88+
Make sure to activate your virtual environment first (if any).
89+
This will be automatically formatted into code, so no need for backticks.
90+
placeholder: manim-slides render mwe.py MWE
91+
render: shell
92+
validations:
93+
required: false
94+
95+
- type: dropdown
2196
id: platform
2297
attributes:
23-
label: Platform
24-
description: What is your platform. Linux, macOS, or Windows?
98+
label: What is your platform?
99+
multiple: true
100+
options:
101+
- Linux
102+
- macOS
103+
- Windows
104+
- Other (please precises below)
25105
validations:
26106
required: true
107+
108+
- type: textarea
109+
id: platform-other
110+
attributes:
111+
label: Other platform
112+
description: Please answer if you have replied *Other* above.
113+
validations:
114+
required: false
115+
116+
- type: textarea
117+
id: code
118+
attributes:
119+
label: Manim Slides Python code
120+
description: |
121+
Please copy and paste a minimal working example (MWE) of your Python code that can reproduce your bug.
122+
This will be automatically formatted into code, so no need for backticks.
123+
placeholder: |
124+
from manim import *
125+
from manim_slides.slide import Slide
126+
127+
128+
class MWE(Slide):
129+
def construct(self):
130+
circle = Circle(radius=2, color=RED)
131+
dot = Dot()
132+
133+
self.play(GrowFromCenter(circle))
134+
135+
self.next_slide(loop=True)
136+
self.play(MoveAlongPath(dot, circle), run_time=0.5)
137+
self.next_slide()
138+
139+
self.play(dot.animate.move_to(ORIGIN))
140+
render: python
141+
validations:
142+
required: false
143+
144+
- type: textarea
145+
id: logs
146+
attributes:
147+
label: Relevant log output
148+
description: |
149+
Please copy and paste any relevant log output.
150+
This will be automatically formatted into code, so no need for backticks.
151+
render: shell
152+
validations:
153+
required: false
154+
27155
- type: textarea
28156
id: screenshots
29157
attributes:
30158
label: Screenshots
31-
description: Please add screenshots if applicable
159+
description: Please add screenshots if applicable.
32160
validations:
33161
required: false
162+
34163
- type: textarea
35-
id: extrainfo
164+
id: extra-info
36165
attributes:
37166
label: Additional information
38167
description: Is there anything else we should know about this bug?
39168
validations:
40169
required: false
170+
171+
- type: textarea
172+
id: suggested-fix
173+
attributes:
174+
label: Recommended fix or suggestions
175+
description: A clear and concise description of how you want to update it.
176+
validations:
177+
required: false

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,61 @@
11
name: Documentation
22
description: Ask / Report an issue related to the documentation.
3-
title: 'DOC: <description>'
4-
labels: [bug, docs]
3+
title: '[DOC] <short-description-here>'
4+
labels: docs
55

66
body:
77
- type: markdown
8+
id: preamble
89
attributes:
9-
value: >
10-
**Thank you for wanting to report a problem with manim-slides docs!**
10+
value: |
11+
**Thank you for reporting a problem about Manim Slides' documentation!**
1112
13+
If you know how to solve your problem, feel free to submit a PR too!
1214
13-
If the problem seems straightforward, feel free to submit a PR instead!
14-
15-
16-
⚠
17-
Verify first that your issue is not already reported on GitHub [Issues].
18-
19-
20-
[Issues]:
21-
https://github.com/jeertmans/manim-slides/issues
15+
- type: checkboxes
16+
id: terms
17+
attributes:
18+
label: Terms
19+
description: 'By submitting this issue, I have:'
20+
options:
21+
- label: Checked the [existing issues](https://github.com/jeertmans/manim-slides/issues?q=is%3Aissue+label%3Adocumentation+) and [discussions](https://github.com/jeertmans/manim-slides/discussions) to see if my issue had not already been reported;
22+
required: true
2223

2324
- type: textarea
25+
id: description
2426
attributes:
25-
label: Describe the Issue
27+
label: Describe the issue
2628
description: A clear and concise description of the issue you encountered.
2729
validations:
2830
required: true
2931

30-
- type: input
32+
- type: textarea
33+
id: pages
3134
attributes:
32-
label: Affected Page
33-
description: Add a link to page with the problem.
35+
label: Affected page(s)
36+
description: Link to page(s) with the problem.
37+
placeholder: |
38+
+ https://manim-slides.eertmans.be/latest/installation.html
39+
+ https://manim-slides.eertmans.be/latest/features_table.html
3440
validations:
3541
required: true
3642

3743
- type: dropdown
44+
id: issue-type
3845
attributes:
39-
label: Issue Type
46+
label: Issue type
4047
description: >
4148
Please select the option in the drop-down.
42-
43-
<details>
44-
<summary>
45-
<em>Issue?</em>
46-
</summary>
47-
</details>
4849
options:
49-
- Documentation Enhancement
50-
- Documentation Report
50+
- Typo, spelling mistake, broken link, etc.
51+
- Something is missing
52+
- Documentation enhancement
53+
- Other
5154
validations:
5255
required: true
5356

5457
- type: textarea
58+
id: suggested-fix
5559
attributes:
5660
label: Recommended fix or suggestions
5761
description: A clear and concise description of how you want to update it.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,42 @@
1-
name: Feature Request
1+
name: Feature request
22
description: Have a new idea/feature? Please suggest!
3+
title: '[FEATURE] <short-description-here>'
34
labels: enhancement
4-
title: '[FEATURE] <description>'
5+
56
body:
7+
- type: markdown
8+
id: preamble
9+
attributes:
10+
value: |
11+
**Thank you for suggesting a new feature!**
12+
13+
If you know how to implement it, feel free to submit a PR too!
14+
15+
- type: checkboxes
16+
id: terms
17+
attributes:
18+
label: Terms
19+
description: 'By submitting this issue, I have:'
20+
options:
21+
- label: Checked the [existing issues](https://github.com/jeertmans/manim-slides/issues?q=is%3Aissue+label%3Adocumentation+) and [discussions](https://github.com/jeertmans/manim-slides/discussions) to see if my issue had not already been reported;
22+
required: true
23+
624
- type: textarea
725
id: description
826
attributes:
927
label: Description
1028
description: A brief description of the enhancement you propose, also include what you tried and what worked.
1129
validations:
1230
required: true
31+
1332
- type: textarea
1433
id: screenshots
1534
attributes:
1635
label: Screenshots
1736
description: Please add screenshots if applicable
1837
validations:
1938
required: false
39+
2040
- type: textarea
2141
id: extrainfo
2242
attributes:

‎.github/ISSUE_TEMPLATE/issue_template.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: Tracking issue
3+
about: Use this template for issue not covered by other templates.
4+
title: "[TRIAGE] <put-description-here>"
5+
labels: tracking issue, needs triage
6+
assignees: octocat
7+
---

‎.github/ISSUE_TEMPLATE/support.yml‎

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎.github/pull_request_template.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,13 @@
1010

1111
<!-- Describe all the proposed changes in your PR -->
1212

13-
## Check List (Check all the applicable boxes)
13+
## Check List
1414

15-
- [ ] I understand that my contributions needs to pass the checks.
16-
- [ ] If I created new functions / methods, I documented them and add type hints.
17-
- [ ] If I modified already existing code, I updated the documentation accordingly.
15+
Check all the applicable boxes:
16+
17+
- [ ] I understand that my contributions needs to pass the checks;
18+
- [ ] If I created new functions / methods, I documented them and add type hints;
19+
- [ ] If I modified already existing code, I updated the documentation accordingly;
1820
- [ ] The title of my pull request is a short description of the requested changes.
1921

2022
## Screenshots

0 commit comments

Comments
 (0)