Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added issue templates #229

Merged
merged 5 commits into from
Nov 13, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions .github/ISSUE_TEMPLATE/bug---maintenance-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
name: Bug & Maintenance Report
description: Report bugs, runtime errors, or other technical issues with the library
title: "[Bug]: "
labels: ["bug"]
projects: []
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
alanvww marked this conversation as resolved.
Show resolved Hide resolved
- type: dropdown
id: type
attributes:
label: Issue Type
multiple: true
options:
- Runtime Error
- Unexpected Behavior
- Performance Issue
- Broken API/Method
- Other
default: 0
validations:
required: true
- type: input
id: version
attributes:
label: ml5.js Version
description: What version of ml5.js are you using? (You can find the version in the browser's developer tools. )
alanvww marked this conversation as resolved.
Show resolved Hide resolved
placeholder: e.g., 1.1.0 / ml5@1
validations:
required: true
- type: input
id: environment
attributes:
label: Development Environment
description: Where are you using ml5?
alanvww marked this conversation as resolved.
Show resolved Hide resolved
placeholder: Local setup, p5 Web Editor, CodePen, etc.
alanvww marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: true
- type: input
id: browser_os
attributes:
label: Browser & Operating System
description: What browser and OS are you using?
alanvww marked this conversation as resolved.
Show resolved Hide resolved
placeholder: Chrome 120 on Windows 11, Safari on iOS 17, etc.
validations:
required: true
- type: textarea
id: description
attributes:
label: Issue Description
placeholder: |
Describe the bug and how to reproduce it. Include:
1. Code snippet showing the issue
2. Expected behavior
3. Actual behavior
4. Screenshots/console errors (if applicable)
alanvww marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: true
- type: textarea
id: minimal_example
attributes:
label: Minimal Reproducible Example
description: Please provide a minimal code example that demonstrates the issue
alanvww marked this conversation as resolved.
Show resolved Hide resolved
placeholder: |
```javascript
// Your code here
```
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct]()
alanvww marked this conversation as resolved.
Show resolved Hide resolved
options:
- label: I agree to follow this project's Code of Conduct
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: ml5.js Discord Server
url: https://discord.gg/FRc2SDyfKN
about: For question like "How to fix this in my code?", Please ask it on our Discord server.
alanvww marked this conversation as resolved.
Show resolved Hide resolved
- name: ml5.js documentation repo
url: https://github.com/ml5js/ml5-website-v02-docsify/issues
about: For issue related to the documentation, please create issue in this repo.
alanvww marked this conversation as resolved.
Show resolved Hide resolved
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-update.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: README/Wiki Update
description: Suggest improvements to the README or Wiki
labels: ["documentation"]
projects: []
assignees: []
body:
- type: dropdown
id: type
attributes:
label: Update Type
multiple: true
options:
- README Update
- Code Examples
- Wiki
- Other
validations:
required: true
- type: textarea
id: current_state
attributes:
label: Current Documentation
description: What's currently in the documentation? Link to relevant sections if possible.
alanvww marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: true
- type: textarea
id: proposed_changes
attributes:
label: Proposed Changes
description: What would you like to see changed or added?
alanvww marked this conversation as resolved.
Show resolved Hide resolved
placeholder: |
Examples:
- Add more examples for specific use cases
- Update outdated information about X
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct]()
alanvww marked this conversation as resolved.
Show resolved Hide resolved
options:
- label: I agree to follow this project's Code of Conduct
required: true
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Feature Request
description: |
Suggest new features or enhancements for ml5.
labels: ["feature request"]
projects: []
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a new feature for our library!
alanvww marked this conversation as resolved.
Show resolved Hide resolved
- type: textarea
id: problem
attributes:
label: Problem Statement
description: What problem would this feature solve? What becomes easier or possible?
placeholder: |
Example: "When working with UV Mapping for FaceMesh, I often need to load the UV coordinates,
but currently have to implement it manually each time..."
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Describe how you envision this feature working
placeholder: |
Example API usage:
```javascript
// Your example code showing how the feature might work
```
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternative Solutions
description: What alternatives have you considered? How are you solving this now?
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct]()
alanvww marked this conversation as resolved.
Show resolved Hide resolved
options:
- label: I agree to follow this project's Code of Conduct
required: true