Added ISSUE_TEMPLATE
This commit is contained in:
Tola Leng
+1
-1
@@ -1,6 +1,6 @@
|
||||
# These are supported funding model platforms
|
||||
|
||||
github: #[tolaleng]
|
||||
github: [tolaleng]
|
||||
patreon: # Replace with a single Patreon username
|
||||
open_collective: #checkcle
|
||||
ko_fi: # Replace with a single Ko-fi username
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
name: Ask for Help
|
||||
description: Ask a question or request guidance about this project.
|
||||
title: "[Question]: "
|
||||
labels: [question]
|
||||
assignees: []
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
**Thank you for reaching out!**
|
||||
Please fill out this form to help us understand your question.
|
||||
|
||||
- type: textarea
|
||||
id: question
|
||||
attributes:
|
||||
label: What do you need help with?
|
||||
description: Clearly describe your question or what you're trying to achieve.
|
||||
placeholder: |
|
||||
I am trying to do X but I'm not sure how to...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: Context
|
||||
description: |
|
||||
Provide any additional context, related issues, or links that help explain your question.
|
||||
placeholder: "Related issues, pull requests, or documentation..."
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: environment
|
||||
attributes:
|
||||
label: Environment Details
|
||||
description: |
|
||||
If applicable, please provide details about your environment (OS, Node version, browser, etc.).
|
||||
placeholder: "Example: Ubuntu 22.04, Node.js v20, Chrome 125"
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: Checklist
|
||||
description: Before submitting, please confirm:
|
||||
options:
|
||||
- label: I have searched existing issues and discussions.
|
||||
required: true
|
||||
- label: I have read the documentation.
|
||||
required: true
|
||||
@@ -0,0 +1,94 @@
|
||||
name: Bug Report
|
||||
description: Report a reproducible bug to help us improve.
|
||||
title: "[Bug]: "
|
||||
labels: [bug]
|
||||
assignees: []
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
**Thank you for taking the time to report a bug!**
|
||||
Please fill out the following template so we can reproduce and fix the issue faster.
|
||||
|
||||
- type: input
|
||||
id: environment
|
||||
attributes:
|
||||
label: Environment
|
||||
description: |
|
||||
Describe where you encountered the issue.
|
||||
(e.g., OS, browser, Node version, etc.)
|
||||
placeholder: "Example: macOS 14.0, Chrome 125, Node.js 20.3.0"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Bug Description
|
||||
description: |
|
||||
A clear and concise description of what the bug is.
|
||||
placeholder: "When I do X, Y happens instead of Z..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: Steps to Reproduce
|
||||
description: |
|
||||
How can we reproduce the behavior?
|
||||
Please list the steps in order.
|
||||
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: What did you expect to happen?
|
||||
placeholder: "The app should..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: screenshots
|
||||
attributes:
|
||||
label: Screenshots or Videos
|
||||
description: |
|
||||
If applicable, add screenshots or screen recordings to help explain your problem.
|
||||
placeholder: "Attach screenshots here."
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Logs
|
||||
description: |
|
||||
If applicable, paste logs or error messages here.
|
||||
Please remove any sensitive information.
|
||||
render: shell
|
||||
placeholder: |
|
||||
```
|
||||
Error: Something went wrong
|
||||
at index.js:123:45
|
||||
```
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: checkboxes
|
||||
id: terms
|
||||
attributes:
|
||||
label: Checklist
|
||||
description: Before submitting, please confirm:
|
||||
options:
|
||||
- label: I have searched existing issues to avoid duplicates.
|
||||
required: true
|
||||
- label: I have provided enough information for reproduction.
|
||||
required: true
|
||||
@@ -0,0 +1,49 @@
|
||||
name: Documentation Improvement
|
||||
description: Suggest improvements or report issues in documentation.
|
||||
title: "[Docs]: "
|
||||
labels: [documentation]
|
||||
assignees: []
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thank you for helping improve our documentation!
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: What part of the documentation needs improvement?
|
||||
description: |
|
||||
Describe the issue clearly.
|
||||
placeholder: "The installation guide is missing steps for..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: location
|
||||
attributes:
|
||||
label: Location
|
||||
description: |
|
||||
Provide a link or path to the affected documentation.
|
||||
placeholder: "https://github.com/operacle/checkcle/docs/INSTALL.md"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: suggestion
|
||||
attributes:
|
||||
label: Suggested Change
|
||||
description: |
|
||||
How would you improve it?
|
||||
placeholder: "I suggest adding a section about..."
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: checkboxes
|
||||
id: confirmation
|
||||
attributes:
|
||||
label: Checklist
|
||||
options:
|
||||
- label: I have searched existing issues for similar documentation problems.
|
||||
required: true
|
||||
@@ -0,0 +1,63 @@
|
||||
name: Feature Request
|
||||
description: Suggest an idea to improve this project.
|
||||
title: "[Feature]: "
|
||||
labels: [enhancement]
|
||||
assignees: []
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
**Thank you for suggesting a feature!**
|
||||
Please fill out this form so we can better understand your idea.
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Feature Description
|
||||
description: |
|
||||
A clear and concise description of the feature you’d like to see.
|
||||
placeholder: "I would like to have..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: motivation
|
||||
attributes:
|
||||
label: Motivation
|
||||
description: |
|
||||
Please explain why this feature would be useful.
|
||||
placeholder: "This feature would help because..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Alternatives Considered
|
||||
description: |
|
||||
Have you considered any alternative solutions or workarounds?
|
||||
placeholder: "I have tried..."
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: additional
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: |
|
||||
Add any other context or screenshots about the feature request here.
|
||||
placeholder: "Links to related issues or references..."
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: Checklist
|
||||
description: Before submitting, please confirm:
|
||||
options:
|
||||
- label: I have searched existing issues to make sure this feature hasn’t been requested yet.
|
||||
required: true
|
||||
- label: I have described the feature clearly and provided supporting details.
|
||||
required: true
|
||||
@@ -0,0 +1,51 @@
|
||||
name: Security Issue
|
||||
description: Report a potential security vulnerability.
|
||||
title: "[Security]: "
|
||||
labels: [security]
|
||||
assignees: []
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
⚠️ **IMPORTANT: Please do NOT disclose sensitive security details in this public issue.**
|
||||
|
||||
If you believe you have found a security vulnerability, **please report it privately** to help keep users safe.
|
||||
|
||||
📧 **Disclosure Process:**
|
||||
- Email: [security@checkcle.io](mailto:security@checkcle.io)
|
||||
- Or follow our [SECURITY.md](../../blob/main/SECURITY.md) policy.
|
||||
|
||||
You can use this issue only to let maintainers know that you have sent or will send a report.
|
||||
|
||||
- type: textarea
|
||||
id: summary
|
||||
attributes:
|
||||
label: Summary
|
||||
description: |
|
||||
Briefly describe the type of vulnerability you believe you have found (without including sensitive details).
|
||||
placeholder: "Example: Possible SQL injection in the user login endpoint."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: contact
|
||||
attributes:
|
||||
label: Contact Information
|
||||
description: |
|
||||
Provide an email or other way for maintainers to contact you if we need clarification.
|
||||
placeholder: "your.email@example.com"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: confirmation
|
||||
attributes:
|
||||
label: Confirmation
|
||||
description: |
|
||||
Please confirm:
|
||||
options:
|
||||
- label: I will not share sensitive exploit details in this issue.
|
||||
required: true
|
||||
- label: I have sent or will send a full report to the private disclosure contact.
|
||||
required: true
|
||||
@@ -0,0 +1,38 @@
|
||||
name: Translation Request
|
||||
description: Request a translation or report translation issues.
|
||||
title: "[Translation]: "
|
||||
labels: [translation]
|
||||
assignees: []
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Help us make this project accessible in more languages!
|
||||
|
||||
- type: input
|
||||
id: language
|
||||
attributes:
|
||||
label: Language
|
||||
description: What language is this about?
|
||||
placeholder: "Example: Spanish"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Details
|
||||
description: |
|
||||
Describe what you’d like to have translated or what issue you found.
|
||||
placeholder: "Please translate the Getting Started guide..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: confirmation
|
||||
attributes:
|
||||
label: Checklist
|
||||
options:
|
||||
- label: I have searched existing issues for similar requests.
|
||||
required: true
|
||||
Reference in New Issue
Block a user