Skip to content

Commit b06cd4d

Browse files
author
Lukas Pistrol
authored
add pr and issues templates (#41)
- these reflect the ones on `CodeEdit`
1 parent 75ba307 commit b06cd4d

File tree

3 files changed

+117
-0
lines changed

3 files changed

+117
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: 🐞 Bug report
2+
description: Something is not working as expected.
3+
title: 🐞 <bug title>
4+
labels: bug
5+
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Description
10+
placeholder: >-
11+
A clear and concise description of what the bug is...
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
attributes:
17+
label: To Reproduce
18+
description: >-
19+
Steps to reliably reproduce the behavior.
20+
placeholder: |
21+
1. Go to '...'
22+
2. Click on '....'
23+
3. Scroll down to '....'
24+
4. See error
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
attributes:
30+
label: Expected Behavior
31+
placeholder: >-
32+
A clear and concise description of what you expected to happen...
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
attributes:
38+
label: Version Information
39+
description: >-
40+
please provide the following information:
41+
value: |
42+
Browser: [e.g. Safari 16.3]
43+
OS: [e.g. macOS 13.2.1, iOS 16.3.1]
44+
Device: [e.g. iPhone 12 Pro Max, MacBook Pro 16"]
45+
46+
- type: textarea
47+
attributes:
48+
label: Additional Context
49+
placeholder: >-
50+
Any other context or considerations about the bug...
51+
52+
- type: textarea
53+
attributes:
54+
label: Screenshots
55+
placeholder: >-
56+
If applicable, please provide relevant screenshots or screen recordings...
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: ✨ Feature request
2+
description: Suggest an idea for this project
3+
title: ✨ <feature title>
4+
labels: enhancement
5+
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Description
10+
placeholder: >-
11+
A clear and concise description of what you would like to happen...
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
attributes:
17+
label: Alternatives Considered
18+
placeholder: >-
19+
Any alternative solutions or features you've considered...
20+
21+
- type: textarea
22+
attributes:
23+
label: Additional Context
24+
placeholder: >-
25+
Any other context or considerations about the feature request...
26+
27+
- type: textarea
28+
attributes:
29+
label: Screenshots
30+
placeholder: >-
31+
If applicable, please provide relevant screenshots or screen recordings...

.github/pull_request_template.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!--- IMPORTANT: If this PR addresses multiple unrelated issues, it will be closed until separated. -->
2+
3+
### Description
4+
5+
<!--- REQUIRED: Describe what changed in detail -->
6+
7+
### Related Issues
8+
9+
<!--- REQUIRED: Tag all related issues (e.g. * #123) -->
10+
<!--- If this PR resolves the issue please specify (e.g. * closes #123) -->
11+
<!--- If this PR addresses multiple issues, these issues must be related to one other -->
12+
13+
* #ISSUE_NUMBER
14+
15+
### Checklist
16+
17+
<!--- Add things that are not yet implemented above -->
18+
19+
- [ ] 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)
20+
- [ ] The issues this PR addresses are related to each other
21+
- [ ] My changes generate no new warnings
22+
- [ ] My code builds and runs on my machine
23+
- [ ] My changes are all related to the related issue above
24+
- [ ] I documented my code
25+
26+
### Screenshots
27+
28+
<!--- REQUIRED: if issue is UI related -->
29+
30+
<!--- IMPORTANT: Fill out all required fields. Otherwise we might close this PR temporarily -->

0 commit comments

Comments
 (0)