Added issue/pull request templates

This commit is contained in:
maziggy
2025-12-09 14:46:52 +00:00
parent 302b8a10cf
commit be77a2c12a
4 changed files with 275 additions and 0 deletions
+126
View File
@@ -0,0 +1,126 @@
name: Bug Report
description: Report a bug or unexpected behavior
title: "[Bug]: "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug! Please fill out the form below.
- type: textarea
id: description
attributes:
label: Bug Description
description: A clear and concise description of what the bug is.
placeholder: Describe what happened...
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What did you expect to happen?
placeholder: Describe what you expected...
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: How can we reproduce this issue?
placeholder: |
1. Go to '...'
2. Click on '...'
3. See error
validations:
required: true
- type: dropdown
id: printer
attributes:
label: Printer Model
description: Which printer model are you using?
options:
- X1 Carbon
- X1
- P1S
- P1P
- A1
- A1 Mini
- H2D
- H2C
- H2S
- Multiple printers
- Not printer-related
validations:
required: true
- type: input
id: version
attributes:
label: Bambuddy Version
description: Which version of Bambuddy are you running? (Check Settings page)
placeholder: e.g., 0.1.5
validations:
required: true
- type: dropdown
id: installation
attributes:
label: Installation Method
description: How did you install Bambuddy?
options:
- Manual (git clone)
- Docker
- Other
validations:
required: true
- type: dropdown
id: os
attributes:
label: Operating System
description: What OS is Bambuddy running on?
options:
- Linux (Ubuntu/Debian)
- Linux (Other)
- macOS
- Windows
- Docker
- Other
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant Logs
description: Please paste any relevant logs here. Check `logs/bambuddy.log` or use `DEBUG=true` for verbose logging.
render: shell
placeholder: |
Paste logs here...
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain your problem.
- type: textarea
id: additional
attributes:
label: Additional Context
description: Add any other context about the problem here.
- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: I have searched existing issues to ensure this bug hasn't already been reported
required: true
- label: I am using the latest version of Bambuddy
required: false
+8
View File
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Documentation
url: https://github.com/maziggy/bambuddy-wiki
about: Check the documentation for guides and troubleshooting
- name: Discussions
url: https://github.com/maziggy/bambuddy/discussions
about: Ask questions and share ideas with the community
@@ -0,0 +1,90 @@
name: Feature Request
description: Suggest a new feature or enhancement
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a feature! Please fill out the form below.
- type: textarea
id: problem
attributes:
label: Problem or Use Case
description: Is your feature request related to a problem? Please describe the use case.
placeholder: I'm always frustrated when...
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Describe the solution you'd like to see.
placeholder: It would be great if...
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: Have you considered any alternative solutions or workarounds?
placeholder: I've tried...
- type: dropdown
id: category
attributes:
label: Feature Category
description: What area does this feature relate to?
options:
- Print Archiving
- Monitoring & Stats
- Print Queue & Scheduling
- Smart Plugs
- Notifications
- Spoolman Integration
- Cloud Profiles
- K-Profiles
- Maintenance Tracking
- File Manager
- UI/UX
- API
- Other
validations:
required: true
- type: dropdown
id: priority
attributes:
label: Priority
description: How important is this feature to you?
options:
- Nice to have
- Would improve my workflow
- Critical for my use case
validations:
required: true
- type: textarea
id: mockups
attributes:
label: Mockups or Examples
description: If you have any mockups, screenshots, or examples from other software, please share them.
- type: checkboxes
id: contribution
attributes:
label: Contribution
options:
- label: I would be willing to help implement this feature
required: false
- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: I have searched existing issues to ensure this feature hasn't already been requested
required: true
+51
View File
@@ -0,0 +1,51 @@
## Description
<!-- Provide a brief description of your changes -->
## Related Issue
<!-- Link to the issue this PR addresses (if applicable) -->
Fixes #
## Type of Change
<!-- Mark the relevant option with an "x" -->
- [ ] Bug fix (non-breaking change that fixes an issue)
- [ ] New feature (non-breaking change that adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] Documentation update
- [ ] Code refactoring
- [ ] Performance improvement
- [ ] Test addition or update
## Changes Made
<!-- List the specific changes made in this PR -->
-
-
-
## Screenshots
<!-- If applicable, add screenshots to demonstrate your changes -->
## Testing
<!-- Describe how you tested your changes -->
- [ ] I have tested this on my local machine
- [ ] I have tested with my printer model: <!-- e.g., X1C, P1S, A1 -->
## Checklist
- [ ] My code follows the project's coding style
- [ ] I have commented my code where necessary
- [ ] I have updated the documentation (if needed)
- [ ] My changes generate no new warnings
- [ ] I have tested my changes thoroughly
## Additional Notes
<!-- Add any additional information that reviewers should know -->