From 334ce8f15248bb796ce86ed1819fbe0fe4f2de0e Mon Sep 17 00:00:00 2001 From: lsouder-ozone3d <131193069+lsouder-ozone3d@users.noreply.github.com> Date: Wed, 30 Jul 2025 11:04:28 -0400 Subject: [PATCH] chore: set up some templates/forms for future contributors --- .github/ISSUE_TEMPLATE/bug-report.yml | 64 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 44 +++++++++++++++ .github/pull_request_template.md | 25 +++++++++ 3 files changed, 133 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.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 000000000..1b25b992d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,64 @@ +name: Bug report +description: Report crashes or incorrect behaviour of existing functionality in QtNodes. +type: Bug +body: + - type: textarea + id: steps + attributes: + label: Description with steps to reproduce + description: Please also describe the actual (current) and expected behaviour and include a code snippet where relevant + placeholder: | + 1. go to ... + 2. then click on ... + 3. then ... + Actual behaviour: + Expected behaviour: + validations: + required: true + - type: textarea + id: evidence + attributes: + label: Supporting files, videos and screenshots + description: | + * A short screen recording (ideally 20sec or less) or screenshot + placeholder: | + Click into this text box and paste your files, videos and screenshots here. + validations: + required: true + - type: input + id: qt_version + attributes: + label: Qt Version + description: What version of Qt does this bug occur on? + placeholder: Qt 5/6? + validations: + required: true + - type: input + id: os + attributes: + label: Operating system + description: What OS does this bug occur on? + placeholder: Windows 11, macOS 13, Ubuntu 22.04, etc. + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional context + description: Further information which may be relevant to this bug + + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: "Before submitting your bug report, please make sure the following requirements are met:" + options: + - label: "I have verified that this issue has not been logged before, by searching the [issue tracker](https://github.com/paceholder/nodeeditor/issues) for similar issues" + required: true + - label: "I have attached all requested files and information to this report" + required: true + - label: "I have attempted to identify the root problem as concisely as possible, and have used minimal reproducible examples where possible" + required: true + - type: markdown + attributes: + value: If an issue does not meet these requirements, it may be closed without investigation. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..4a84ca980 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,44 @@ +name: Feature request +description: Request new functionality or enhancements. +type: Feature +body: + - type: textarea + id: idea + attributes: + label: Your idea + description: Describe your idea in a few sentences. + validations: + required: true + - type: textarea + id: whatfor + attributes: + label: Problem to be solved + description: What problem would your idea solve? + validations: + required: true + - type: textarea + id: other + attributes: + label: Prior art + description: Have you run into this problem with other apps? How did they solve it? You can paste screenshots. + validations: + required: false + - type: textarea + id: context + attributes: + label: Additional context + description: Anything else of note + validations: + required: false + + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: "Before submitting your bug report, please make sure the following requirements are met:" + options: + - label: "I have verified that this feature request has not been logged before, by searching the [issue tracker](https://github.com/paceholder/nodeeditor/issues) for similar requests" + required: true + - type: markdown + attributes: + value: If a feature request does not meet these requirements, it may be closed without investigation. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..f340a1d25 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,25 @@ +## Type of change +- [ ] Bug fix +- [ ] New feature +- [ ] Breaking change +- [ ] Documentation/refactoring + +## Description + + +## Testing +- Qt version tested: +- [ ] Existing tests still pass +- [ ] Added tests for new functionality (if applicable) + +## Breaking changes? + + +## Related issue + + +--- +*Please fill out the sections above to help reviewers understand your changes.* \ No newline at end of file