From faf2e97a171714f20b870e207d2275b1405efd8d Mon Sep 17 00:00:00 2001 From: Ian Bassi Date: Tue, 25 Nov 2025 16:01:48 -0300 Subject: [PATCH] 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. --- .github/ISSUE_TEMPLATE/bug_report.yml | 45 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++++ .github/ISSUE_TEMPLATE/feature_request.yml | 46 ++++++++++++++++++++++ .github/pull_request_template.md | 15 +++++++ 4 files changed, 114 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..96ea1f1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0665707 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..2249d4e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..fcaa84e --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,15 @@ +# Description + + + +## Related OrcaSlicer PRs + +