diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 136b1e507..d4a0b1e16 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,14 +1,14 @@ name: 🐞 Bug report description: Something is not working as expected. -title: 🐞 YOUR_DESCRIPTION +title: 🐞 labels: bug body: - type: textarea attributes: label: Description - description: >- - A clear and concise description of what the bug is. + placeholder: >- + A clear and concise description of what the bug is... validations: required: true @@ -16,7 +16,7 @@ body: attributes: label: To Reproduce description: >- - Steps to reproduce the behavior. + Steps to reliably reproduce the behavior. placeholder: | 1. Go to '...' 2. Click on '....' @@ -27,26 +27,30 @@ body: - type: textarea attributes: - label: Expected behavior - description: >- - A clear and concise description of what you expected to happen. + label: Expected Behavior + placeholder: >- + A clear and concise description of what you expected to happen... validations: required: true - type: textarea attributes: - label: Version information + label: Version Information description: >- click on the version number on the welcome screen value: | - CodeEditTextView: [e.g. 1.0] - macOS: [e.g. 12.3.0] - Xcode: [e.g. 13.3] - validations: - required: true + CodeEditTextView: [e.g. 0.x.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: Additional context - description: >- - Add any other context about the problem here. + 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 index d861e8d3f..476a7721e 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,36 +1,31 @@ name: ✨ Feature request description: Suggest an idea for this project -title: ✨ YOUR_DESCRIPTION +title: ✨ labels: enhancement body: - - type: input - attributes: - label: Is your feature request related to a problem? Please describe. - placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - validations: - required: false - - type: textarea attributes: - label: Describe the solution you'd like + label: Description placeholder: >- - A clear and concise description of what you want to happen. + A clear and concise description of what you would like to happen... validations: required: true - type: textarea attributes: - label: Describe alternatives you've considered + label: Alternatives Considered placeholder: >- - A clear and concise description of any alternative solutions or features you've considered. - validations: - required: true + Any alternative solutions or features you've considered... - type: textarea attributes: - label: Additional context + label: Additional Context placeholder: >- - Add any other context or screenshots about the feature request here. - validations: - required: true + 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 000000000..d976c3fa5 --- /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 + + + +