-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[chore]: add pr and issue templates (#32)
add pr and issue templates - the templates reflect the ones on `CodeEdit`
- Loading branch information
1 parent
323fce7
commit a2ced29
Showing
3 changed files
with
117 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
name: 🐞 Bug report | ||
description: Something is not working as expected. | ||
title: 🐞 <bug 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... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
name: ✨ Feature request | ||
description: Suggest an idea for this project | ||
title: ✨ <feature 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... |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
<!--- IMPORTANT: If this PR addresses multiple unrelated issues, it will be closed until separated. --> | ||
|
||
### Description | ||
|
||
<!--- REQUIRED: Describe what changed in detail --> | ||
|
||
### Related Issues | ||
|
||
<!--- REQUIRED: Tag all related issues (e.g. * #123) --> | ||
<!--- If this PR resolves the issue please specify (e.g. * closes #123) --> | ||
<!--- If this PR addresses multiple issues, these issues must be related to one other --> | ||
|
||
* #ISSUE_NUMBER | ||
|
||
### Checklist | ||
|
||
<!--- Add things that are not yet implemented above --> | ||
|
||
- [ ] 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 | ||
|
||
<!--- REQUIRED: if issue is UI related --> | ||
|
||
<!--- IMPORTANT: Fill out all required fields. Otherwise we might close this PR temporarily --> |