docs: first draft of issue and PR template

This commit is contained in:
Fazri Gading
2026-01-23 06:00:36 +08:00
parent bb474fe233
commit da843257c1
15 changed files with 683 additions and 0 deletions

View File

@@ -0,0 +1,54 @@
name: Asset Contribution
description: Contribute assets (images, sounds, models, etc.)
title: "[ASSETS] "
labels: ["assets"]
body:
- type: textarea
id: description
attributes:
label: Asset Description
description: Describe the asset(s) you're contributing.
placeholder: "What type of asset is this? What does it represent?"
validations:
required: true
- type: input
id: format
attributes:
label: File Format
description: What format are the asset files in?
placeholder: "e.g. PNG, JPG, MP3, OBJ"
- type: input
id: license
attributes:
label: License
description: What license applies to this asset?
placeholder: "e.g. CC0, MIT, Public Domain"
- type: textarea
id: usage
attributes:
label: Intended Usage
description: Where and how should this asset be used in the project?
placeholder: "This asset should be used for..., in the following context..."
- type: textarea
id: source
attributes:
label: Source/Attribution
description: If this asset is derived from another source, provide attribution.
placeholder: "Created by me, or derived from [source]"
- type: input
id: link
attributes:
label: Download Link
description: Provide a link to download or view the asset.
placeholder: "GitHub release, Google Drive, etc."
- type: textarea
id: additional
attributes:
label: Additional Information
description: Any other information about the asset.

84
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@@ -0,0 +1,84 @@
name: Bug Report
description: Create a report to help us improve
title: "[BUG] "
labels: ["bug"]
body:
- type: textarea
id: description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
placeholder: "Tell us what you see! The more detail the better."
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: To Reproduce
description: Steps to reproduce the behavior
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain your problem.
- type: input
id: version
attributes:
label: Version
description: What version of the project are you running?
placeholder: "e.g. v1.2.3"
validations:
required: true
- type: dropdown
id: os
attributes:
label: Operating System
description: What operating system are you using?
options:
- Windows
- macOS
- Linux
- iOS
- Android
- Other
validations:
required: true
- type: dropdown
id: browser
attributes:
label: Browser (if applicable)
description: What browser are you using?
options:
- Chrome
- Firefox
- Safari
- Edge
- Opera
- Other
- N/A
- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context about the problem here.

View File

@@ -0,0 +1,42 @@
name: Feature Request
description: Suggest an idea for this project
title: "[FEATURE] "
labels: ["enhancement"]
body:
- type: textarea
id: summary
attributes:
label: Summary
description: Brief explanation of the feature.
placeholder: "Describe in a few sentences what this feature would do."
validations:
required: true
- type: textarea
id: problem
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
placeholder: "Ex. I'm always frustrated when [...]"
- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
placeholder: "Describe what you want to happen."
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
placeholder: "Describe any alternative solutions or features you've considered."
- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.

View File

@@ -0,0 +1,61 @@
name: Security Vulnerability
description: Report a security vulnerability
title: "[SECURITY] "
labels: ["security"]
body:
- type: markdown
attributes:
value: |
Thank you for reporting a security vulnerability. Please review our [Security Policy](SECURITY.md) for more information on how we handle security issues.
If you are reporting a security vulnerability, please provide as much detail as possible so we can assess and address it promptly.
- type: textarea
id: summary
attributes:
label: Summary
description: Brief description of the security issue.
placeholder: "Describe the security vulnerability in a few sentences."
validations:
required: true
- type: textarea
id: details
attributes:
label: Vulnerability Details
description: Detailed description of the vulnerability, including how it can be exploited.
placeholder: "Provide detailed steps, code snippets, or other information that demonstrates the vulnerability."
validations:
required: true
- type: textarea
id: impact
attributes:
label: Impact
description: What is the potential impact of this vulnerability?
placeholder: "Describe the potential consequences if this vulnerability is exploited."
validations:
required: true
- type: textarea
id: mitigation
attributes:
label: Suggested Mitigation
description: Any suggestions for fixing or mitigating the issue.
placeholder: "Provide any suggestions for how to fix or mitigate this vulnerability."
- type: input
id: contact
attributes:
label: Contact Information (Optional)
description: How can we contact you for more information?
placeholder: "Email address or other contact method"
- type: checkboxes
id: terms
attributes:
label: Terms
description: By submitting this issue, you agree to our responsible disclosure terms.
options:
- label: I understand that this is a private security report and will not publicly disclose details until the issue is resolved.
required: true

View File

@@ -0,0 +1,54 @@
name: Support Request
description: Request help or support
title: "[SUPPORT] "
labels: ["support"]
body:
- type: textarea
id: question
attributes:
label: What do you need help with?
description: Describe your question or issue clearly.
placeholder: "I'm having trouble with..."
validations:
required: true
- type: textarea
id: context
attributes:
label: Context
description: Provide any relevant context or background information.
placeholder: "I've tried..., I expected..., but got..."
- type: input
id: version
attributes:
label: Version
description: What version are you using?
placeholder: "e.g. v1.2.3"
- type: dropdown
id: platform
attributes:
label: Platform
description: What platform are you using?
options:
- Windows
- macOS
- Linux
- iOS
- Android
- Web Browser
- Other
- type: textarea
id: logs
attributes:
label: Logs or Error Messages
description: If applicable, paste any error messages or logs here.
render: shell
- type: textarea
id: additional
attributes:
label: Additional Information
description: Any other information that might help us assist you.

View File

@@ -0,0 +1,42 @@
name: Translation Request
description: Request translation for text or content
title: "[TRANSLATION] "
labels: ["translation"]
body:
- type: input
id: language
attributes:
label: Target Language
description: What language do you want to translate to?
placeholder: "e.g. Spanish (es-ES), French (fr-FR)"
validations:
required: true
- type: textarea
id: source_text
attributes:
label: Source Text
description: The original text that needs to be translated.
placeholder: "Paste the text here..."
validations:
required: true
- type: textarea
id: context
attributes:
label: Context
description: Provide context about where this text appears or how it's used.
placeholder: "This text appears in..., It's used for..."
- type: input
id: file_location
attributes:
label: File Location
description: Where is this text located in the codebase?
placeholder: "e.g. src/components/Button.js:15"
- type: textarea
id: notes
attributes:
label: Additional Notes
description: Any specific instructions or notes for the translator.