circuitpython/.github/ISSUE_TEMPLATE/bug_report.yml

64 lines
2.0 KiB
YAML
Raw Normal View History

2021-06-30 06:12:22 -04:00
name: 🐞 Bug Report
description: Create a bug report to help us improve
2021-06-30 00:32:32 -04:00
labels:
- bug
body:
- type: markdown
attributes:
value: >-
2023-02-11 22:30:25 -05:00
Thanks for testing out CircuitPython! Now that you have encountered a
2021-06-30 06:12:22 -04:00
bug... you can file a report for it.
- type: textarea
2021-06-30 00:32:32 -04:00
id: firmware
attributes:
label: CircuitPython version
description: >-
Include the version of CircuitPython you're running. You can see it in
2021-06-30 06:12:22 -04:00
the `boot_out.txt` file, as well as in the `REPL`.
placeholder: Adafruit CircuitPython 6.2.0 on 2021-03-01; Raspberry Pi Pico with rp2040
render: python
2021-06-30 06:12:22 -04:00
validations:
required: true
2021-06-30 00:32:32 -04:00
- type: textarea
id: code
attributes:
label: Code/REPL
2021-06-30 06:12:22 -04:00
description: This is automatically rendered as Python, so no need for backticks.
placeholder: |
import busio, bitbangio
2021-06-30 00:32:32 -04:00
i2c = bitbangio.I2C(board.GP1, board.GP0)
render: python
2021-06-30 06:12:22 -04:00
validations:
required: true
2021-06-30 00:32:32 -04:00
- type: textarea
id: behavior
attributes:
label: Behavior
2021-06-30 06:12:22 -04:00
description: What happens when you run the code above? Include error messages (if any).
placeholder: |
```python
2021-06-30 06:12:22 -04:00
Traceback (most recent call last):
2021-06-30 00:32:32 -04:00
File "<stdin>", line 1, in <module>
TimeoutError: Clock stretch too long
2021-06-30 06:12:22 -04:00
```
On-board led pulses red.
validations:
required: true
2021-06-30 00:32:32 -04:00
- type: textarea
id: description
attributes:
label: Description
description: Optionally, describe the bug in more detail.
2021-06-30 06:12:22 -04:00
placeholder: |
- Error while using i2c...
- Only happens when...
2021-06-30 00:32:32 -04:00
- might be related to #4291...
- type: textarea
id: more-info
attributes:
label: Additional information
description: >-
Optionally, add any other information like hardware connection, scope
2021-06-30 06:12:22 -04:00
output etc. If you have already done some debugging, mention it here.
placeholder: Removing [this](url) line resolves the issue.