Skip to content

Commit d231512

Browse files
alanvwwshiffman
alanvww
and
shiffman
authored
Added issue templates (#229)
* Add issue templates * Update feature_request.yml * Apply suggestions from code review Co-authored-by: Daniel Shiffman <[email protected]> * Remove title property of bug report --------- Co-authored-by: Daniel Shiffman <[email protected]>
1 parent 2c4ee5e commit d231512

File tree

4 files changed

+179
-0
lines changed

4 files changed

+179
-0
lines changed

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

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
name: Bug & Maintenance Report
2+
description: Report bugs, runtime errors, or other technical issues with the library
3+
labels: ["bug"]
4+
projects: []
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thank you for taking the time to fill out this bug report!
11+
- type: dropdown
12+
id: type
13+
attributes:
14+
label: Issue Type
15+
multiple: true
16+
options:
17+
- Runtime Error
18+
- Unexpected Behavior
19+
- Performance Issue
20+
- Broken API/Method
21+
- Other
22+
default: 0
23+
validations:
24+
required: true
25+
- type: input
26+
id: version
27+
attributes:
28+
label: ml5.js Version
29+
description: Which version of ml5.js are you using? (You can find the version in the browser's developer tools and with `console.log(ml5.version)`)
30+
placeholder: e.g., 1.1.0 / ml5@1
31+
validations:
32+
required: true
33+
- type: input
34+
id: environment
35+
attributes:
36+
label: Development Environment
37+
description: Where are you using ml5.js?
38+
placeholder: Local setup, p5.js Web Editor, CodePen, etc.
39+
validations:
40+
required: true
41+
- type: input
42+
id: browser_os
43+
attributes:
44+
label: Browser & Operating System
45+
description: Which browser and operating system are you using?
46+
placeholder: Chrome 120 on Windows 11, Safari on iOS 17, etc.
47+
validations:
48+
required: true
49+
- type: textarea
50+
id: description
51+
attributes:
52+
label: Issue Description
53+
placeholder: |
54+
Please describe the bug and how to reproduce it. Include:
55+
1. A code snippet showing the issue
56+
2. The expected behavior
57+
3. The actual behavior
58+
4. Screenshots or console errors (if applicable)
59+
validations:
60+
required: true
61+
- type: textarea
62+
id: minimal_example
63+
attributes:
64+
label: Minimal Reproducible Example
65+
description: Please provide a minimal code example that demonstrates the issue.
66+
placeholder: |
67+
```javascript
68+
// Your code here
69+
```
70+
validations:
71+
required: false
72+
- type: checkboxes
73+
id: terms
74+
attributes:
75+
label: Code of Conduct
76+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/ml5js/Code-of-Conduct)
77+
options:
78+
- label: I agree to follow this project's Code of Conduct
79+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: ml5.js Discord Server
4+
url: https://discord.gg/FRc2SDyfKN
5+
about: For questions like "How do I fix this in my code?", please ask on our Discord server.
6+
- name: ml5.js Documentation Repo
7+
url: https://github.com/ml5js/ml5-website-v02-docsify/issues
8+
about: For issues related to the documentation, please create an issue in the documentation repo.

‎.github/ISSUE_TEMPLATE/documentation-update.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: README/Wiki Update
2+
description: Suggest improvements to the README or Wiki
3+
labels: ["documentation"]
4+
projects: []
5+
assignees: []
6+
body:
7+
- type: dropdown
8+
id: type
9+
attributes:
10+
label: Update Type
11+
multiple: true
12+
options:
13+
- README Update
14+
- Code Examples
15+
- Wiki
16+
- Other
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: current_state
21+
attributes:
22+
label: Current Documentation
23+
description: What is currently in the documentation? Link to relevant sections if possible.
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: proposed_changes
28+
attributes:
29+
label: Proposed Changes
30+
description: What changes or additions would you like to see?
31+
placeholder: |
32+
Examples:
33+
- Add more examples for specific use cases
34+
- Update outdated information about X
35+
validations:
36+
required: true
37+
- type: checkboxes
38+
id: terms
39+
attributes:
40+
label: Code of Conduct
41+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/ml5js/Code-of-Conduct)
42+
options:
43+
- label: I agree to follow this project's Code of Conduct
44+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Feature Request
2+
description: |
3+
Suggest new features or enhancements for ml5.
4+
labels: ["feature request"]
5+
projects: []
6+
assignees: []
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thank you for suggesting a new feature for our library!
12+
- type: textarea
13+
id: problem
14+
attributes:
15+
label: Problem Statement
16+
description: What problem would this feature solve? What becomes easier or possible?
17+
placeholder: |
18+
Example: "When working with UV Mapping for FaceMesh, I often need to load the UV coordinates,
19+
but currently have to implement it manually each time..."
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: solution
24+
attributes:
25+
label: Proposed Solution
26+
description: Describe how you envision this feature working
27+
placeholder: |
28+
Example API usage:
29+
```javascript
30+
// Your example code showing how the feature might work
31+
```
32+
validations:
33+
required: true
34+
- type: textarea
35+
id: alternatives
36+
attributes:
37+
label: Alternative Solutions
38+
description: What alternatives have you considered? How are you solving this now?
39+
validations:
40+
required: false
41+
- type: checkboxes
42+
id: terms
43+
attributes:
44+
label: Code of Conduct
45+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/ml5js/Code-of-Conduct)
46+
options:
47+
- label: I agree to follow this project's Code of Conduct
48+
required: true

0 commit comments

Comments
 (0)