Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chore]: add pr and issues template #12

Merged
merged 1 commit into from
Mar 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
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: |
CodeEditSymbols: [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...
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
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...
30 changes: 30 additions & 0 deletions .github/pull_request_template.md
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 -->