Skip to content
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
81 changes: 81 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
name: Bug Report
description: Report a bug in a driver or module.
title: "<component>: <short description>"
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for reporting a bug! Please fill in the details below.

- type: textarea
id: description
attributes:
label: Description
description: What happened? What did you expect instead?
placeholder: |
When I call `sensor.temperature()`, the returned value is always 0.0.
I expected a plausible room temperature (~20-30°C).
validations:
required: true

- type: textarea
id: steps
attributes:
label: Steps to reproduce
description: Minimal code or steps to trigger the bug.
placeholder: |
```python
from machine import I2C
from hts221 import HTS221
sensor = HTS221(I2C(1))
print(sensor.temperature()) # always 0.0
```
validations:
required: true

- type: dropdown
id: component
attributes:
label: Driver / Component
description: Which driver or module is affected?
options:
- apds9960
- bme280
- bq27441
- daplink_flash
- gc9a01
- hts221
- im34dt05
- ism330dl
- lis2mdl
- mcp23009e
- ssd1327
- steami_config
- vl53l1x
- wsen-hids
- wsen-pads
- Other
validations:
required: true

- type: textarea
id: environment
attributes:
label: Environment
description: MicroPython version, board revision, firmware version.
placeholder: |
- MicroPython: v1.24.1
- Board revision: 3
- DAPLink firmware: 0259
validations:
required: false

- type: textarea
id: logs
attributes:
label: Logs / Output
description: Paste any relevant error messages or output.
render: text
validations:
required: false
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: STeaMi Website
url: https://www.steami.cc/
about: Visit the STeaMi website for general information.
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
name: Documentation
description: Report missing or incorrect documentation.
title: "docs: <short description>"
labels: ["documentation"]
body:
- type: markdown
attributes:
value: |
Help us improve the documentation!

- type: textarea
id: what
attributes:
label: What needs documentation
description: What is missing, unclear, or incorrect?
placeholder: |
The APDS9960 README does not document the gesture recognition methods
(gesture(), set_gesture_gain(), etc.).
validations:
required: true

- type: dropdown
id: component
attributes:
label: Driver / Component
description: Which driver or module is concerned?
options:
- apds9960
- bme280
- bq27441
- daplink_flash
- gc9a01
- hts221
- im34dt05
- ism330dl
- lis2mdl
- mcp23009e
- ssd1327
- steami_config
- vl53l1x
- wsen-hids
- wsen-pads
- README / CONTRIBUTING
- Wiki (wiki.steami.cc)
validations:
required: true

- type: textarea
id: current
attributes:
label: Current state
description: What documentation exists now?
placeholder: The README only has a basic "Installation" section.
validations:
required: false

- type: textarea
id: desired
attributes:
label: Desired state
description: What should be added or changed?
placeholder: |
Add a "Gesture Recognition" section with:
- Method signatures and return values
- Example code
- Supported gestures list
validations:
required: false
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: Feature Request
description: Suggest a new feature or improvement.
title: "<component>: <short description>"
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Describe the feature you'd like and why it would be useful.

- type: textarea
id: description
attributes:
label: Description
description: What do you want and why?
placeholder: |
I would like a `heading()` method on LIS2MDL that returns the compass
bearing in degrees (0-360), so I can build a digital compass without
computing atan2 manually.
validations:
required: true

- type: dropdown
id: component
attributes:
label: Driver / Component
description: Which driver or module is concerned?
options:
- apds9960
- bme280
- bq27441
- daplink_flash
- gc9a01
- hts221
- im34dt05
- ism330dl
- lis2mdl
- mcp23009e
- ssd1327
- steami_config
- vl53l1x
- wsen-hids
- wsen-pads
- New driver
- Project-wide
validations:
required: true

- type: textarea
id: api
attributes:
label: Proposed API
description: Show how you would like to use this feature.
render: python
placeholder: |
mag = LIS2MDL(I2C(1))
print("Heading:", mag.heading(), "°")
validations:
required: false

- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Any workarounds or other approaches you've thought of?
validations:
required: false
18 changes: 18 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## Summary

<!-- What does this PR do? Reference the issue: Closes #XXX -->

## Changes

<!-- List the main changes -->

-

## Checklist

- [ ] `ruff check` passes
- [ ] `python -m pytest tests/ -k mock -v` passes (no mock test broken)
- [ ] Tested on hardware (if applicable)
- [ ] README updated (if adding/changing public API)
- [ ] Examples added/updated (if applicable)
- [ ] Commit messages follow `<scope>: <Description.>` format
Loading