From 9b62b62386086ff4e34244aba0612eb57dfc85d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9rome=20Eertmans?= Date: Fri, 19 Jul 2024 15:32:26 +0200 Subject: [PATCH] chore(ci): rework issue templates (#456) * chore(ci): rework issue templates Closes #406 * chore(ci): small fixes * up * add changelog entry --- .github/ISSUE_TEMPLATE/bug.yml | 157 +++++++++++++++++++-- .github/ISSUE_TEMPLATE/documentation.yml | 56 ++++---- .github/ISSUE_TEMPLATE/feature_request.yml | 24 +++- .github/ISSUE_TEMPLATE/issue_template.md | 7 + .github/ISSUE_TEMPLATE/support.yml | 14 -- .github/pull_request_template.md | 10 +- 6 files changed, 212 insertions(+), 56 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/issue_template.md delete mode 100644 .github/ISSUE_TEMPLATE/support.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index d60bea6..0bd8d62 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -1,40 +1,177 @@ name: Bug description: Report an issue to help improve the project. +title: '[BUG] ' labels: bug -title: '[BUG] ' + body: +- type: markdown + id: preamble + attributes: + value: | + **Thank you for reporting a problem about Manim Slides!** + + If you know how to solve your problem, feel free to submit a PR too! + + > ![WARNING] + > Before reporting your bug, please make sure to: + > + > 1. create and activate virtual environment (venv); + > 2. install `manim-slides` and the necessary dependencies; + > 3. and reduce your Python to a minimal working example (MWE). + > + > You can skip the last step if your issue occurs during installation. + +- type: checkboxes + id: terms + attributes: + label: Terms + description: 'By submitting this issue, I have:' + options: + - 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; + required: true + - label: Read the [installation instructions](https://manim-slides.eertmans.be/latest/installation.html); + required: true + - label: Created a virtual environment in which I can reproduce my bug; + - type: textarea id: description attributes: - label: Description - description: A brief description of the question or issue, also include what you tried and what didn't work + label: Describe the issue + description: A description of the issue, also include what you tried and what didn't work. validations: required: true + - type: textarea - id: version + id: command attributes: - label: Version - description: Which version of Manim Slides are you using? You can use `manim-slides --version` to get that information. + label: Command + description: | + Enter the command that failed. + This will be automatically formatted into code, so no need for backticks. + render: shell validations: required: true + +- type: dropdown + id: issue-type + attributes: + label: Issue Type + description: > + Please select the option in the drop-down. + options: + - Installation issue + - Visual bug when presenting (`manim-slides present`) + - Bug when presenting with HTML/PowerPoint/... format (`manim-slides convert`) + - Other + validations: + required: true + - type: textarea + id: py-version + attributes: + label: Python version + description: | + Please copy and paste the output of `python --version`. + Make sure to activate your virtual environment first (if any). + This will be automatically formatted into code, so no need for backticks. + placeholder: Python 3.11.8 + render: shell + validations: + required: false + +- type: textarea + id: venv + attributes: + label: Python environment + description: | + Please copy and paste the output of `pip freeze`. + Make sure to activate your virtual environment first (if any). + This will be automatically formatted into code, so no need for backticks. + placeholder: manim-slides render mwe.py MWE + render: shell + validations: + required: false + +- type: dropdown id: platform attributes: - label: Platform - description: What is your platform. Linux, macOS, or Windows? + label: What is your platform? + multiple: true + options: + - Linux + - macOS + - Windows + - Other (please precises below) validations: required: true + +- type: textarea + id: platform-other + attributes: + label: Other platform + description: Please answer if you have replied *Other* above. + validations: + required: false + +- type: textarea + id: code + attributes: + label: Manim Slides Python code + description: | + Please copy and paste a minimal working example (MWE) of your Python code that can reproduce your bug. + This will be automatically formatted into code, so no need for backticks. + placeholder: | + from manim import * + from manim_slides.slide import Slide + + + class MWE(Slide): + def construct(self): + circle = Circle(radius=2, color=RED) + dot = Dot() + + self.play(GrowFromCenter(circle)) + + self.next_slide(loop=True) + self.play(MoveAlongPath(dot, circle), run_time=0.5) + self.next_slide() + + self.play(dot.animate.move_to(ORIGIN)) + render: python + validations: + required: false + +- type: textarea + id: logs + attributes: + label: Relevant log output + description: | + Please copy and paste any relevant log output. + This will be automatically formatted into code, so no need for backticks. + render: shell + validations: + required: false + - type: textarea id: screenshots attributes: label: Screenshots - description: Please add screenshots if applicable + description: Please add screenshots if applicable. validations: required: false + - type: textarea - id: extrainfo + id: extra-info attributes: label: Additional information description: Is there anything else we should know about this bug? validations: required: false + +- type: textarea + id: suggested-fix + attributes: + label: Recommended fix or suggestions + description: A clear and concise description of how you want to update it. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml index 794a21f..264b6ca 100644 --- a/.github/ISSUE_TEMPLATE/documentation.yml +++ b/.github/ISSUE_TEMPLATE/documentation.yml @@ -1,57 +1,61 @@ name: Documentation description: Ask / Report an issue related to the documentation. -title: 'DOC: ' -labels: [bug, docs] +title: '[DOC] ' +labels: docs body: - type: markdown + id: preamble attributes: - value: > - **Thank you for wanting to report a problem with manim-slides docs!** + value: | + **Thank you for reporting a problem about Manim Slides' documentation!** + If you know how to solve your problem, feel free to submit a PR too! - If the problem seems straightforward, feel free to submit a PR instead! - - - ⚠ - Verify first that your issue is not already reported on GitHub [Issues]. - - - [Issues]: - https://github.com/jeertmans/manim-slides/issues +- type: checkboxes + id: terms + attributes: + label: Terms + description: 'By submitting this issue, I have:' + options: + - 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; + required: true - type: textarea + id: description attributes: - label: Describe the Issue + label: Describe the issue description: A clear and concise description of the issue you encountered. validations: required: true -- type: input +- type: textarea + id: pages attributes: - label: Affected Page - description: Add a link to page with the problem. + label: Affected page(s) + description: Link to page(s) with the problem. + placeholder: | + + https://manim-slides.eertmans.be/latest/installation.html + + https://manim-slides.eertmans.be/latest/features_table.html validations: required: true - type: dropdown + id: issue-type attributes: - label: Issue Type + label: Issue type description: > Please select the option in the drop-down. - -
- - Issue? - -
options: - - Documentation Enhancement - - Documentation Report + - Typo, spelling mistake, broken link, etc. + - Something is missing + - Documentation enhancement + - Other validations: required: true - type: textarea + id: suggested-fix attributes: label: Recommended fix or suggestions description: A clear and concise description of how you want to update it. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 0529bb2..dec963c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,8 +1,26 @@ -name: Feature Request +name: Feature request description: Have a new idea/feature? Please suggest! +title: '[FEATURE] ' labels: enhancement -title: '[FEATURE] ' + body: +- type: markdown + id: preamble + attributes: + value: | + **Thank you for suggesting a new feature!** + + If you know how to implement it, feel free to submit a PR too! + +- type: checkboxes + id: terms + attributes: + label: Terms + description: 'By submitting this issue, I have:' + options: + - 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; + required: true + - type: textarea id: description attributes: @@ -10,6 +28,7 @@ body: description: A brief description of the enhancement you propose, also include what you tried and what worked. validations: required: true + - type: textarea id: screenshots attributes: @@ -17,6 +36,7 @@ body: description: Please add screenshots if applicable validations: required: false + - type: textarea id: extrainfo attributes: diff --git a/.github/ISSUE_TEMPLATE/issue_template.md b/.github/ISSUE_TEMPLATE/issue_template.md new file mode 100644 index 0000000..8e5bfa1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue_template.md @@ -0,0 +1,7 @@ +--- +name: Tracking issue +about: Use this template for issue not covered by other templates. +title: "[TRIAGE] " +labels: tracking issue, needs triage +assignees: octocat +--- diff --git a/.github/ISSUE_TEMPLATE/support.yml b/.github/ISSUE_TEMPLATE/support.yml deleted file mode 100644 index acd7f39..0000000 --- a/.github/ISSUE_TEMPLATE/support.yml +++ /dev/null @@ -1,14 +0,0 @@ -name: Question/Help/Support -description: Ask us about Manim Slides -title: 'Support: Ask us anything' -labels: [help, question] - -body: -- type: textarea - attributes: - label: "Please explain the issue you're experiencing (with as much detail as possible):" - description: > - Please make sure to leave a reference to the document/code you're - referring to. - validations: - required: true diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 600953f..e26704e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -10,11 +10,13 @@ -## Check List (Check all the applicable boxes) +## Check List -- [ ] I understand that my contributions needs to pass the checks. -- [ ] If I created new functions / methods, I documented them and add type hints. -- [ ] If I modified already existing code, I updated the documentation accordingly. +Check all the applicable boxes: + +- [ ] I understand that my contributions needs to pass the checks; +- [ ] If I created new functions / methods, I documented them and add type hints; +- [ ] If I modified already existing code, I updated the documentation accordingly; - [ ] The title of my pull request is a short description of the requested changes. ## Screenshots