Add issue and PR templates for GitHub (#11)

Introduces templates for bug reports, feature requests, and pull requests to standardize contributions and improve issue tracking. Also adds configuration to direct users to community support and discussion forums.
This commit is contained in:
Ian Bassi
2025-11-25 16:01:48 -03:00
committed by GitHub
parent 8713df3150
commit faf2e97a17
4 changed files with 114 additions and 0 deletions

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

@@ -0,0 +1,45 @@
name: 🐞 Error Report
description: File an error report
labels: ["Error"]
body:
- type: markdown
attributes:
value: |
**Thank you for using OrcaSlicer and wanting to report an error.**
Please note that this is only for reportings errors in the OrcaSlicer Wiki.
For issues with OrcaSlicer itself, please use the main [OrcaSlicer GitHub repository](https://github.com/OrcaSlicer/OrcaSlicer/issues).
Before filing, please check if the issue already exists (either open or closed) by using the search bar on the issues page. If it does, comment there. Even if it's closed, we can reopen it based on your comment.
- type: checkboxes
attributes:
label: Is there an existing issue for this problem?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: input
id: error_page
attributes:
label: Wiki Page
description: Which page or section of the wiki does this issue relate to?
placeholder: e.g. quality_settings_line_width
validations:
required: true
- type: textarea
id: error_description
attributes:
label: Error description
description: Please describe the error you encountered in detail.
placeholder: e.g. "The instructions on this page did not work as expected because..."
validations:
required: true
- type: textarea
id: file_uploads
attributes:
label: Attachments to improve the page.
description: If you want to update some files (images, code snippets, etc.) to improve the wiki page, please attach them here.
placeholder: |
You can attach images, code snippets, or any other relevant files that would help improve the wiki page.
validations:
required: false

8
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Community Support (Discord channel)
url: https://discord.gg/P4VE9UY9gJ
about: Please ask and answer support "how do I?"questions here.
- name: Discussion Forum
url: https://github.com/OrcaSlicer/OrcaSlicer/discussions
about: Please raise ideas and feature suggestions here.

View File

@@ -0,0 +1,46 @@
name: 🚀 Entry Request / Enhancement
description: Suggest an improvement to make Orca Slicer even better!
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this Entry request!
If your idea is still at the formulation stage, or you're not sure it would
be useful to many users, you can raise it as a discussion topic under [Ideas](https://github.com/OrcaSlicer/OrcaSlicer/discussions/categories/ideas)
or you can raise it on the [Discord server](https://discord.gg/P4VE9UY9gJ).
- type: checkboxes
attributes:
label: Is there an existing issue for this feature request?
description: |
Please search to see if an issue already exists for a feature, or perhaps one similar.
You can then comment and react so that we know know much interest there is in the feature request.
options:
- label: I have searched the existing issues
required: true
- type: input
id: enhancement_page
attributes:
label: Wiki Page
description: Which page or section of the wiki does this issue relate to?
placeholder: e.g. quality_settings_line_width
validations:
required: true
- type: textarea
attributes:
label: Feature / Enhancement Description
description: A clear and concise description of the enhancement or new page you'd like to see.
placeholder: |
e.g. "It would be great to have a page that explains how to set up custom supports because..."
validations:
required: true
- type: textarea
attributes:
label: Additional context
description: |
Add any other context, diagrams, illustations or screenshots about the feature request here.
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false

15
.github/pull_request_template.md vendored Normal file
View File

@@ -0,0 +1,15 @@
# Description
<!--
> Please provide a summary of the changes made in this PR. Include details such as:
> * What issue does this PR address or fix?
> * What new features or enhancements does this PR introduce?
> * Are there any breaking changes or dependencies that need to be considered?
-->
## Related OrcaSlicer PRs
<!--
> Please list any related OrcaSlicer PRs that are associated with this documentation update.
> e.g. https://github.com/OrcaSlicer/OrcaSlicer/pull/[PR_NUMBER]
-->