Skip to content

UI Library for Design Engineers. Animated components and effects you can copy and paste into your apps. Free. Open Source.

feat: update template (#798)

Dillion Vermaf893a4c098f4
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index dd84ea78..00000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,38 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 00000000..72860cb8
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,85 @@
+name: "Bug report"
+description: Report an issue with Magic UI
+title: "[bug]: "
+labels: ["bug"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ ### Thanks for taking the time to create a bug report. Please search open/closed issues before submitting, as the issue may have already been reported/addressed.
+
+ - type: markdown
+ attributes:
+ value: |
+ #### If you aren't sure this is a bug or not, please open a discussion instead:
+ - [Discussions](https://github.com/magicuidesign/magicui/discussions/new?category=general)
+
+ - type: textarea
+ id: bug-description
+ attributes:
+ label: Describe the bug
+ description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us how in the description. Thanks!
+ placeholder: Bug description
+ validations:
+ required: true
+
+ - type: input
+ id: components-affected
+ attributes:
+ label: Affected component/components
+ description: Which Magic UI components are affected?
+ placeholder: ex. Rainbow Button, Terminal...
+ validations:
+ required: true
+
+ - type: textarea
+ id: reproduction
+ attributes:
+ label: How to reproduce
+ description: A step-by-step description of how to reproduce the bug.
+ placeholder: |
+ 1. Go to '...'
+ 2. Click on '....'
+ 3. See error
+ validations:
+ required: true
+
+ - type: input
+ id: codesandbox-stackblitz
+ attributes:
+ label: Codesandbox/StackBlitz link
+ description: |
+ A link to a CodeSandbox or StackBlitz that includes a minimal reproduction of the problem. In rare cases when not applicable, you can link to a GitHub repository that we can easily run to recreate the issue. If a report is vague and does not have a reproduction, it will be closed without warning.
+
+ > [!CAUTION]
+ > If you skip this step, this issue might be **labeled** with `please add a reproduction` and **closed**.
+ validations:
+ required: false
+
+ - type: textarea
+ id: logs
+ attributes:
+ label: Logs
+ description: "Please include browser console and server logs around the time this bug occurred. Optional if provided reproduction. Please try not to insert an image but copy paste the log text."
+ render: bash
+
+ - type: textarea
+ id: system-info
+ attributes:
+ label: System Info
+ description: Information about browsers, system or binaries that's relevant.
+ render: bash
+ placeholder: System, Binaries, Browsers
+ validations:
+ required: true
+
+ - type: checkboxes
+ id: terms
+ attributes:
+ label: Before submitting
+ description: By submitting this issue, you agree to follow our [Contributing Guidelines](https://github.com/magicuidesign/magicui/blob/main/CONTRIBUTING.md).
+ options:
+ - label: I've made research efforts and searched the documentation
+ required: true
+ - label: I've searched for existing issues
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
deleted file mode 100644
index 8c1bfb4b..00000000
--- a/.github/ISSUE_TEMPLATE/documentation.md
+++ /dev/null
@@ -1,19 +0,0 @@
----
-name: Documentation
-about: Suggest an edit for the documentation
-title: ""
-labels: ""
-assignees: ""
----
-
-**Describe the documentation change**
-A clear and concise description of what you'd like to see changed or added in the documentation.
-
-**Current documentation**
-If applicable, provide a link or reference to the current documentation that needs to be updated.
-
-**Proposed change**
-Describe the change you'd like to see in the documentation. Be as specific as possible.
-
-**Additional context**
-Add any other context or screenshots about the documentation request here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index bbcbbe7d..00000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 00000000..7186e9e2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,55 @@
+name: "Feature request"
+description: Create a feature request for Magic UI
+title: "[feat]: "
+labels: ["area: request"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ ### Thanks for taking the time to create a feature request! Please search open/closed issues before submitting, as the issue may have already been reported/addressed.
+
+ - type: markdown
+ attributes:
+ value: |
+ #### If you aren't sure this is a bug or not, please open a discussion instead:
+ - [Discussions](https://github.com/magicuidesign/magicui/discussions/new?category=general)
+
+ - type: textarea
+ id: feature-description
+ attributes:
+ label: Feature description
+ description: Tell us about your feature request
+ placeholder: "I think this feature would be great because..."
+ value: "Describe your feature request..."
+ validations:
+ required: true
+
+ - type: input
+ id: components-affected
+ attributes:
+ label: Affected component/components
+ description: Is this feature request relevant to any of the already existing components?
+ placeholder: ex. Button, Checkbox...
+ validations:
+ required: false
+
+ - type: textarea
+ id: context
+ attributes:
+ label: Additional Context
+ description: Add any other context about the feature here.
+ placeholder: ex. screenshots, Stack Overflow links, forum links, etc.
+ value: "Additional details here..."
+ validations:
+ required: false
+
+ - type: checkboxes
+ id: terms
+ attributes:
+ label: Before submitting
+ description: By submitting this issue, you agree to follow our [Contributing Guidelines](https://github.com/magicuidesign/magicui/blob/main/CONTRIBUTING.md).
+ options:
+ - label: I've made research efforts and searched the documentation
+ required: true
+ - label: I've searched for existing issues and PRs
+ required: true