Skip to content

Commit e08e5d9

Browse files
Schero94Schero94
committed
feat: enhance GitHub issue templates with Editor.js specific fields and feature request template
- Add comprehensive bug report template with Editor.js/browser specific fields - Add feature request template for editor tools and features - Enhance config.yml with multiple helpful links - Add emoji icons and structured validation
1 parent 164329b commit e08e5d9

File tree

3 files changed

+231
-16
lines changed

3 files changed

+231
-16
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 134 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,159 @@
1-
name: Bug Report
2-
description: File a bug report
1+
name: 🐛 Bug Report
2+
description: Report a bug or issue with Magic Editor X
33
title: '[Bug]: '
4+
labels: ['bug', 'needs-triage']
45
body:
56
- type: markdown
67
attributes:
78
value: |
8-
Thanks for taking the time to fill out this bug report!
9+
## Thanks for taking the time to report a bug!
10+
11+
Please fill out the information below to help us reproduce and fix the issue.
12+
913
- type: textarea
10-
id: issue-experiencing
14+
id: bug-description
1115
attributes:
12-
label: What issue are you experiencing?
13-
description: A detailed explanation of the issue
16+
label: 🐛 Bug Description
17+
description: A clear and concise description of what the bug is
18+
placeholder: Describe the bug you're experiencing...
1419
validations:
1520
required: true
21+
22+
- type: textarea
23+
id: expected-behavior
24+
attributes:
25+
label: ✅ Expected Behavior
26+
description: What did you expect to happen?
27+
placeholder: Describe what should happen...
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: actual-behavior
33+
attributes:
34+
label: ❌ Actual Behavior
35+
description: What actually happened?
36+
placeholder: Describe what actually happened...
37+
validations:
38+
required: true
39+
1640
- type: textarea
1741
id: reproduction-steps
1842
attributes:
19-
label: Steps To Reproduce
20-
description: Steps to reproduce the behavior.
43+
label: 🔄 Steps To Reproduce
44+
description: Steps to reproduce the behavior
2145
placeholder: |
22-
1. In this environment...
23-
2. With this config...
24-
3. Run '...'
46+
1. Open the editor...
47+
2. Add a block/tool...
48+
3. Perform action...
2549
4. See error...
2650
validations:
27-
required: false
51+
required: true
52+
53+
- type: dropdown
54+
id: feature-area
55+
attributes:
56+
label: 📦 Feature Area
57+
description: Which feature is affected?
58+
options:
59+
- Editor.js Core
60+
- Editor Tools (Header, List, Image, etc.)
61+
- Media Library Integration
62+
- Live Collaboration
63+
- AI Assistant
64+
- Custom Tools/Buttons
65+
- Saving/Loading Content
66+
- Other
67+
validations:
68+
required: true
69+
2870
- type: input
2971
id: plugin-version
3072
attributes:
31-
label: What version of the plugin are you using?
73+
label: 📦 Plugin Version
74+
description: Which version of magic-editor-x are you using?
75+
placeholder: e.g. 1.0.0
3276
validations:
3377
required: true
78+
3479
- type: input
3580
id: strapi-version
3681
attributes:
37-
label: What strapi version are you using?
82+
label: 🚀 Strapi Version
83+
description: Which version of Strapi are you using?
84+
placeholder: e.g. 5.31.2
85+
validations:
86+
required: true
87+
88+
- type: input
89+
id: node-version
90+
attributes:
91+
label: 🟢 Node Version
92+
description: Which version of Node.js are you using?
93+
placeholder: e.g. 20.19.4
3894
validations:
3995
required: true
96+
97+
- type: dropdown
98+
id: browser
99+
attributes:
100+
label: 🌐 Browser
101+
description: Which browser are you using?
102+
options:
103+
- Chrome
104+
- Firefox
105+
- Safari
106+
- Edge
107+
- Other
108+
validations:
109+
required: false
110+
111+
- type: textarea
112+
id: error-logs
113+
attributes:
114+
label: 📋 Error Logs
115+
description: Please paste any relevant error logs (check browser console)
116+
placeholder: Paste error logs here...
117+
render: shell
118+
validations:
119+
required: false
120+
121+
- type: textarea
122+
id: editor-config
123+
attributes:
124+
label: ⚙️ Editor Configuration
125+
description: Your editor configuration (if relevant)
126+
placeholder: |
127+
// Custom field configuration
128+
{
129+
type: 'customField',
130+
name: 'magic-editor-x',
131+
options: {
132+
// your config here
133+
}
134+
}
135+
render: javascript
136+
validations:
137+
required: false
138+
139+
- type: textarea
140+
id: additional-context
141+
attributes:
142+
label: 📝 Additional Context
143+
description: Add any other context, screenshots, or videos
144+
placeholder: Any additional information that might help...
145+
validations:
146+
required: false
147+
148+
- type: checkboxes
149+
id: terms
150+
attributes:
151+
label: ✔️ Checklist
152+
description: Please confirm the following
153+
options:
154+
- label: I have searched for similar issues before creating this one
155+
required: true
156+
- label: I have provided all the required information above
157+
required: true
158+
- label: I have removed any sensitive information from logs
159+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
1+
blank_issues_enabled: false
12
contact_links:
2-
- name: Discussions
3+
- name: 💬 Discussions
34
url: https://github.com/Schero94/magic-editor-x/discussions
4-
about: Use discussions for improvements and/or questions
5+
about: Ask questions, share ideas, and discuss with the community
6+
- name: 📖 Documentation
7+
url: https://github.com/Schero94/magic-editor-x#readme
8+
about: Read the full documentation and setup guide
9+
- name: 🐛 Existing Issues
10+
url: https://github.com/Schero94/magic-editor-x/issues
11+
about: Check if your issue has already been reported
12+
- name: ⭐ Star on GitHub
13+
url: https://github.com/Schero94/magic-editor-x
14+
about: Show your support by starring the repository

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
name: 💡 Feature Request
2+
description: Suggest a new feature or enhancement for Magic Editor X
3+
title: '[Feature]: '
4+
labels: ['enhancement', 'needs-triage']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Thanks for suggesting a feature!
10+
11+
Please describe your idea in detail below.
12+
13+
- type: dropdown
14+
id: feature-area
15+
attributes:
16+
label: 📦 Feature Area
17+
description: Which part of the plugin does this feature relate to?
18+
options:
19+
- New Editor Tool/Block
20+
- Existing Editor Tool Enhancement
21+
- Media Library Integration
22+
- Live Collaboration
23+
- AI Assistant
24+
- Custom Field Configuration
25+
- Admin UI
26+
- API / Backend
27+
- Documentation
28+
- Other
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: problem
34+
attributes:
35+
label: 🤔 Problem / Use Case
36+
description: What problem does this feature solve? Or what use case does it enable?
37+
placeholder: Describe the problem or use case...
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: solution
43+
attributes:
44+
label: 💡 Proposed Solution
45+
description: How would you like to see this feature implemented?
46+
placeholder: Describe your proposed solution...
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: alternatives
52+
attributes:
53+
label: 🔄 Alternatives Considered
54+
description: Have you considered any alternative solutions or workarounds?
55+
placeholder: Describe any alternatives you've considered...
56+
validations:
57+
required: false
58+
59+
- type: textarea
60+
id: example
61+
attributes:
62+
label: 📝 Example / Mockup
63+
description: Provide code examples, mockups, or screenshots if applicable
64+
placeholder: Provide visual examples or code snippets...
65+
validations:
66+
required: false
67+
68+
- type: textarea
69+
id: additional-context
70+
attributes:
71+
label: 📚 Additional Context
72+
description: Add any other context, screenshots, or links
73+
placeholder: Any additional information...
74+
validations:
75+
required: false
76+
77+
- type: checkboxes
78+
id: terms
79+
attributes:
80+
label: ✔️ Checklist
81+
options:
82+
- label: I have searched for similar feature requests before creating this one
83+
required: true
84+
- label: This feature would benefit the broader community
85+
required: false

0 commit comments

Comments
 (0)