Skip to content

Commit fe94128

Browse files
authored
Add templates for pull requests, feature requests and bug reports (#632)
* feat: add issue templates * feat: add pull request template * feat: make it more clear how to check a box
1 parent 9fb401d commit fe94128

File tree

3 files changed

+186
-0
lines changed

3 files changed

+186
-0
lines changed
Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
name: Bug Report
2+
description: Report a problem you are facing
3+
labels: ['bug']
4+
assignees: []
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for helping to improve openSenseMap! Please fill out the sections below. They help us to track down the issuer faster.
11+
12+
- type: checkboxes
13+
id: checklist
14+
attributes:
15+
label: Before You Proceed
16+
description: Please verify these items before submitting.
17+
options:
18+
- label: I have cleared my browsers cache and the issue still remains
19+
- label: I have tried a different browser to see if it is related
20+
- label: I have searched existing issues to avoid duplicates
21+
required: false
22+
23+
- type: textarea
24+
id: description
25+
attributes:
26+
label: Description
27+
description:
28+
Please give us a detailed description of the issue you are seeing.
29+
Screenshots and videos help as well.
30+
placeholder: |
31+
What went wrong and where? Can you provide screenshots?
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: expected-behavior
37+
attributes:
38+
label: Expected Behavior
39+
description: What should have happened?
40+
placeholder: |
41+
Please describe the correct/desired outcome.
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: steps-to-reproduce
47+
attributes:
48+
label: Steps to reproduce
49+
description: Please provide a list of actions to trigger the bug.
50+
placeholder: |
51+
1. ...
52+
2. ...
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
id: environment
58+
attributes:
59+
label: Environment
60+
description: OS, browser, version, and any relevant extensions or plugins.
61+
placeholder: |
62+
e.g., Windows 11, Chrome 119.0.6045.105, no extensions
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
id: console-logs
68+
attributes:
69+
label: Console Output
70+
description:
71+
If you come across any error logs, e.g., in your browser console please
72+
provide them here.
73+
render: shell
74+
validations:
75+
required: false
76+
77+
- type: textarea
78+
id: workaround
79+
attributes:
80+
label: Workaround
81+
description: Did you find a workaround?
82+
validations:
83+
required: false
84+
85+
- type: textarea
86+
id: additional-info
87+
attributes:
88+
label: Additional Information
89+
description: Anything else that might help us investigate.
90+
validations:
91+
required: false

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Feature Request
2+
description: Suggest a new feature or improvement
3+
labels: ['enhancement']
4+
assignees: []
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thank you for your interest in openSenseMap! Please fill out the sections below – clear requests make it easier for the team to evaluate and implement them!
11+
12+
- type: textarea
13+
id: description
14+
attributes:
15+
label: Description
16+
description:
17+
Summarize what you would like to be implemented. Focus on what this
18+
does, over the why you want it.
19+
placeholder: |
20+
A brief overview of the requested functionality.
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: use-case
26+
attributes:
27+
label: Use case
28+
description:
29+
Explain the scenario or workflow that would benefit from this feature.
30+
placeholder: |
31+
Describe who would use it and how it improves their experience.
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: implementation-ideas
37+
attributes:
38+
label: Implementation ideas (optional)
39+
description:
40+
If you already have an idea on how to implement this, this is the place
41+
to put your thoughts.
42+
placeholder: |
43+
Possible approaches, libraries, or design considerations.
44+
validations:
45+
required: false
46+
47+
- type: textarea
48+
id: additional-info
49+
attributes:
50+
label: Additional information (optional)
51+
description:
52+
Any other details, mockups, or links that help illustrate the request.
53+
validations:
54+
required: false

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<!--
2+
THANK YOU FOR CONTRIBUTING!
3+
-->
4+
5+
## Type of Change
6+
7+
<!--
8+
Try sticking to one type of change per pull request for easier and faster code reviews.
9+
Just put an x between the [] to check the box.
10+
-->
11+
12+
- [ ] Dependency upgrade
13+
- [ ] Bug fix (non-breaking change)
14+
- [ ] Breaking change
15+
- e.g. a fixed bug or new feature that may break something else
16+
- [ ] New feature
17+
- [ ] Code quality improvements
18+
- e.g. refactoring, documentation, tests, tooling, ...
19+
20+
## Implementation
21+
22+
<!--
23+
What did you change and why? How does it work?
24+
Are there any trade-offs or limitations?
25+
-->
26+
27+
## Checklist
28+
29+
- [ ] I gave this pull request a meaningful title
30+
- [ ] My pull request is targeting the `dev` branch
31+
- [ ] I have added documentation to my code
32+
- [ ] I have deleted code that I have commented out
33+
34+
## Additional Information
35+
36+
<!--
37+
Please link any additional issue, discussion or pull request here.
38+
This helps us to keep everything tidy and managable.
39+
-->
40+
41+
- This PR closes #

0 commit comments

Comments
 (0)