Skip to content

Commit 8d8d341

Browse files
nedsebnedseb
authored
tooling: Add GitHub issue and PR templates. (#225)
* tooling: Add GitHub issue and PR templates. * tooling: Address PR review comments on templates.
1 parent 23c7f82 commit 8d8d341

5 files changed

Lines changed: 239 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: Bug Report
2+
description: Report a bug in a driver or module.
3+
title: "<component>: <short description>"
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for reporting a bug! Please fill in the details below.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: What happened? What did you expect instead?
16+
placeholder: |
17+
When I call `sensor.temperature()`, the returned value is always 0.0.
18+
I expected a plausible room temperature (~20-30°C).
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: steps
24+
attributes:
25+
label: Steps to reproduce
26+
description: Minimal code or steps to trigger the bug.
27+
placeholder: |
28+
```python
29+
from machine import I2C
30+
from hts221 import HTS221
31+
sensor = HTS221(I2C(1))
32+
print(sensor.temperature()) # always 0.0
33+
```
34+
validations:
35+
required: true
36+
37+
- type: dropdown
38+
id: component
39+
attributes:
40+
label: Driver / Component
41+
description: Which driver or module is affected?
42+
options:
43+
- apds9960
44+
- bme280
45+
- bq27441
46+
- daplink_flash
47+
- gc9a01
48+
- hts221
49+
- im34dt05
50+
- ism330dl
51+
- lis2mdl
52+
- mcp23009e
53+
- ssd1327
54+
- steami_config
55+
- vl53l1x
56+
- wsen-hids
57+
- wsen-pads
58+
- Other
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
id: environment
64+
attributes:
65+
label: Environment
66+
description: MicroPython version, board revision, firmware version.
67+
placeholder: |
68+
- MicroPython: v1.24.1
69+
- Board revision: 3
70+
- DAPLink firmware: 0259
71+
validations:
72+
required: false
73+
74+
- type: textarea
75+
id: logs
76+
attributes:
77+
label: Logs / Output
78+
description: Paste any relevant error messages or output.
79+
render: text
80+
validations:
81+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: STeaMi Website
4+
url: https://www.steami.cc/
5+
about: Visit the STeaMi website for general information.

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: Documentation
2+
description: Report missing or incorrect documentation.
3+
title: "docs: <short description>"
4+
labels: ["documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Help us improve the documentation!
10+
11+
- type: textarea
12+
id: what
13+
attributes:
14+
label: What needs documentation
15+
description: What is missing, unclear, or incorrect?
16+
placeholder: |
17+
The APDS9960 README does not document the gesture recognition methods
18+
(gesture(), set_gesture_gain(), etc.).
19+
validations:
20+
required: true
21+
22+
- type: dropdown
23+
id: component
24+
attributes:
25+
label: Driver / Component
26+
description: Which driver or module is concerned?
27+
options:
28+
- apds9960
29+
- bme280
30+
- bq27441
31+
- daplink_flash
32+
- gc9a01
33+
- hts221
34+
- im34dt05
35+
- ism330dl
36+
- lis2mdl
37+
- mcp23009e
38+
- ssd1327
39+
- steami_config
40+
- vl53l1x
41+
- wsen-hids
42+
- wsen-pads
43+
- README / CONTRIBUTING
44+
- Wiki (wiki.steami.cc)
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: current
50+
attributes:
51+
label: Current state
52+
description: What documentation exists now?
53+
placeholder: The README only has a basic "Installation" section.
54+
validations:
55+
required: false
56+
57+
- type: textarea
58+
id: desired
59+
attributes:
60+
label: Desired state
61+
description: What should be added or changed?
62+
placeholder: |
63+
Add a "Gesture Recognition" section with:
64+
- Method signatures and return values
65+
- Example code
66+
- Supported gestures list
67+
validations:
68+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: Feature Request
2+
description: Suggest a new feature or improvement.
3+
title: "<component>: <short description>"
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Describe the feature you'd like and why it would be useful.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: What do you want and why?
16+
placeholder: |
17+
I would like a `heading()` method on LIS2MDL that returns the compass
18+
bearing in degrees (0-360), so I can build a digital compass without
19+
computing atan2 manually.
20+
validations:
21+
required: true
22+
23+
- type: dropdown
24+
id: component
25+
attributes:
26+
label: Driver / Component
27+
description: Which driver or module is concerned?
28+
options:
29+
- apds9960
30+
- bme280
31+
- bq27441
32+
- daplink_flash
33+
- gc9a01
34+
- hts221
35+
- im34dt05
36+
- ism330dl
37+
- lis2mdl
38+
- mcp23009e
39+
- ssd1327
40+
- steami_config
41+
- vl53l1x
42+
- wsen-hids
43+
- wsen-pads
44+
- New driver
45+
- Project-wide
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
id: api
51+
attributes:
52+
label: Proposed API
53+
description: Show how you would like to use this feature.
54+
render: python
55+
placeholder: |
56+
mag = LIS2MDL(I2C(1))
57+
print("Heading:", mag.heading(), "°")
58+
validations:
59+
required: false
60+
61+
- type: textarea
62+
id: alternatives
63+
attributes:
64+
label: Alternatives considered
65+
description: Any workarounds or other approaches you've thought of?
66+
validations:
67+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## Summary
2+
3+
<!-- What does this PR do? Reference the issue: Closes #XXX -->
4+
5+
## Changes
6+
7+
<!-- List the main changes -->
8+
9+
-
10+
11+
## Checklist
12+
13+
- [ ] `ruff check` passes
14+
- [ ] `python -m pytest tests/ -k mock -v` passes (no mock test broken)
15+
- [ ] Tested on hardware (if applicable)
16+
- [ ] README updated (if adding/changing public API)
17+
- [ ] Examples added/updated (if applicable)
18+
- [ ] Commit messages follow `<scope>: <Description.>` format

0 commit comments

Comments
 (0)