Add GitHub Issue templates (#383)
This commit is contained in:
parent
d3118704ea
commit
bcd9e1a494
5 changed files with 166 additions and 0 deletions
37
.github/ISSUE_TEMPLATE/1_feature_request.yml
vendored
Normal file
37
.github/ISSUE_TEMPLATE/1_feature_request.yml
vendored
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
name: Feature request
|
||||
description: Suggest an enhancement or new feature
|
||||
title: "[FEATURE] "
|
||||
labels: ["enhancement"]
|
||||
assignees: []
|
||||
body:
|
||||
- type: textarea
|
||||
id: summary
|
||||
attributes:
|
||||
label: Summary
|
||||
description: One-line summary of the requested feature
|
||||
placeholder: Brief description of what you'd like to see added
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: motivation
|
||||
attributes:
|
||||
label: Motivation / Use case
|
||||
description: Why is this feature needed? What problem does it solve?
|
||||
placeholder: Describe the problem or use case that this feature would address
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: proposal
|
||||
attributes:
|
||||
label: Proposed solution
|
||||
description: Brief implementation idea or API surface
|
||||
placeholder: How do you envision this feature working?
|
||||
- type: dropdown
|
||||
id: impact
|
||||
attributes:
|
||||
label: Impact
|
||||
options:
|
||||
- Low
|
||||
- Medium
|
||||
- High
|
||||
description: Estimated impact on users or project
|
||||
69
.github/ISSUE_TEMPLATE/2_bug_report.yml
vendored
Normal file
69
.github/ISSUE_TEMPLATE/2_bug_report.yml
vendored
Normal file
|
|
@ -0,0 +1,69 @@
|
|||
name: Bug report
|
||||
description: Create a report to help us fix a bug
|
||||
title: "[BUG] "
|
||||
labels: ["bug"]
|
||||
assignees: []
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: troubleshooting
|
||||
attributes:
|
||||
label: Prerequisites
|
||||
description: Please confirm you have completed the following steps before submitting this bug report
|
||||
options:
|
||||
- label: I have read the [troubleshooting guide](https://github.com/nicotsx/zerobyte/blob/main/TROUBLESHOOTING.md)
|
||||
required: true
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Bug Description
|
||||
description: Brief description of what went wrong
|
||||
placeholder: Describe the issue...
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: Steps to Reproduce
|
||||
description: List the steps to reproduce the bug
|
||||
placeholder: |
|
||||
1. Go to...
|
||||
2. Click on...
|
||||
3. See error...
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: What should have happened?
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: Zerobyte version / commit
|
||||
placeholder: e.g., v1.2.3 or commit sha
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: deployment
|
||||
attributes:
|
||||
label: Deployment Method
|
||||
options:
|
||||
- Docker Compose
|
||||
- Docker
|
||||
- Local Development
|
||||
- Other
|
||||
- type: textarea
|
||||
id: backup_context
|
||||
attributes:
|
||||
label: Backup/Repository Context
|
||||
description: If this is related to backup operations, provide details about the repository type, storage backend, etc.
|
||||
placeholder: e.g., S3 repository, local filesystem, specific backup operation that failed
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Logs / Error Messages
|
||||
description: Check browser console (F12) or server logs for errors. Remove any sensitive information.
|
||||
validations:
|
||||
required: true
|
||||
20
.github/ISSUE_TEMPLATE/3_question.yml
vendored
Normal file
20
.github/ISSUE_TEMPLATE/3_question.yml
vendored
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
name: Question
|
||||
description: General questions about usage or implementation
|
||||
title: "[QUESTION] "
|
||||
labels: ["question"]
|
||||
assignees: []
|
||||
body:
|
||||
- type: textarea
|
||||
id: question
|
||||
attributes:
|
||||
label: Question
|
||||
description: Provide a clear question and any minimal code samples
|
||||
placeholder: What would you like to know about Zerobyte?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: Context / what you've tried
|
||||
description: Provide context about what you're trying to accomplish and what you've already tried
|
||||
placeholder: I'm trying to... and I've already tried...
|
||||
21
.github/ISSUE_TEMPLATE/4_security.yml
vendored
Normal file
21
.github/ISSUE_TEMPLATE/4_security.yml
vendored
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
name: Security
|
||||
description: Report a security vulnerability (do not file public issues)
|
||||
title: "[SECURITY] "
|
||||
labels: ["security"]
|
||||
assignees: []
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: >-
|
||||
**⚠️ SECURITY VULNERABILITY NOTICE ⚠️**
|
||||
|
||||
If you believe you've found a security vulnerability, **do not open a public issue**.
|
||||
|
||||
Please report security vulnerabilities privately through one of these methods:
|
||||
|
||||
- Use GitHub's private security advisory feature: [Report a vulnerability](https://github.com/nicotsx/zerobyte/security/advisories/new)
|
||||
- Contact the maintainers directly via email if listed in the repository
|
||||
|
||||
This helps us address security issues responsibly before they can be exploited.
|
||||
|
||||
**Thank you for helping keep Zerobyte secure! 🔒**
|
||||
19
.github/ISSUE_TEMPLATE/5_blank.yml
vendored
Normal file
19
.github/ISSUE_TEMPLATE/5_blank.yml
vendored
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
name: Blank Issue
|
||||
description: Create a blank issue for anything that doesn't fit other templates
|
||||
title: ""
|
||||
labels: []
|
||||
assignees: []
|
||||
body:
|
||||
- type: textarea
|
||||
id: content
|
||||
attributes:
|
||||
label: Issue Details
|
||||
description: Describe your issue, question, or request
|
||||
placeholder: |
|
||||
Please provide as much detail as possible about your issue.
|
||||
|
||||
If this is a bug, consider using the Bug Report template instead.
|
||||
If this is a feature request, consider using the Feature Request template instead.
|
||||
If you have a question, consider using the Question template instead.
|
||||
validations:
|
||||
required: true
|
||||
Loading…
Reference in a new issue