From a2ced29c0abe5bd1fd6111884a01bd4cac61f0bc Mon Sep 17 00:00:00 2001 From: Lukas Pistrol Date: Thu, 16 Mar 2023 08:22:06 +0100 Subject: [PATCH] [chore]: add pr and issue templates (#32) add pr and issue templates - the templates reflect the ones on `CodeEdit` --- .github/ISSUE_TEMPLATE/bug_report.yml | 56 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 31 ++++++++++++ .github/pull_request_template.md | 30 ++++++++++++ 3 files changed, 117 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 0000000..9b08fe8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,56 @@ +name: 🐞 Bug report +description: Something is not working as expected. +title: 🐞 +labels: bug + +body: + - type: textarea + attributes: + label: Description + placeholder: >- + A clear and concise description of what the bug is... + validations: + required: true + + - type: textarea + attributes: + label: To Reproduce + description: >- + Steps to reliably reproduce the behavior. + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + + - type: textarea + attributes: + label: Expected Behavior + placeholder: >- + A clear and concise description of what you expected to happen... + validations: + required: true + + - type: textarea + attributes: + label: Version Information + description: >- + click on the version number on the welcome screen + value: | + CodeEditLanguages: [e.g. 0.0.x-alpha.y] + macOS: [e.g. 13.2.1] + Xcode: [e.g. 14.2] + + - type: textarea + attributes: + label: Additional Context + placeholder: >- + Any other context or considerations about the bug... + + - type: textarea + attributes: + label: Screenshots + placeholder: >- + If applicable, please provide relevant screenshots or screen recordings... diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..476a772 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,31 @@ +name: ✨ Feature request +description: Suggest an idea for this project +title: ✨ +labels: enhancement + +body: + - type: textarea + attributes: + label: Description + placeholder: >- + A clear and concise description of what you would like to happen... + validations: + required: true + + - type: textarea + attributes: + label: Alternatives Considered + placeholder: >- + Any alternative solutions or features you've considered... + + - type: textarea + attributes: + label: Additional Context + placeholder: >- + Any other context or considerations about the feature request... + + - type: textarea + attributes: + label: Screenshots + placeholder: >- + If applicable, please provide relevant screenshots or screen recordings... diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..d976c3f --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,30 @@ + + +### Description + + + +### Related Issues + + + + + +* #ISSUE_NUMBER + +### Checklist + + + +- [ ] I read and understood the [contributing guide](https://github.com/CodeEditApp/CodeEdit/blob/main/CONTRIBUTING.md) as well as the [code of conduct](https://github.com/CodeEditApp/CodeEdit/blob/main/CODE_OF_CONDUCT.md) +- [ ] The issues this PR addresses are related to each other +- [ ] My changes generate no new warnings +- [ ] My code builds and runs on my machine +- [ ] My changes are all related to the related issue above +- [ ] I documented my code + +### Screenshots + + + +