mirror of
https://github.com/micropython/micropython.git
synced 2025-07-21 13:01:10 +02:00
Update to the issue forms added earlier this year, that seem to generally be working well. Improvements in this commit: - No longer generates TODO checklists in new issues. - Issue bodies (and therefore email previews) no longer start with the same fixed checklist text for each new issue. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>
47 lines
1.7 KiB
YAML
47 lines
1.7 KiB
YAML
name: Documentation issue
|
|
description: Report areas of the documentation or examples that need improvement
|
|
title: "docs: "
|
|
labels: ["documentation"]
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
This form is for reporting issues with the documentation or examples provided with MicroPython.
|
|
|
|
If you have a general question \"How Do I ...?\", please post it on [GitHub Discussions](https://github.com/orgs/micropython/discussions/) or [Discord](https://discord.gg/RB8HZSAExQ) instead of here.
|
|
|
|
#### Existing issue?
|
|
|
|
* Please search for [existing issues](https://github.com/micropython/micropython/issues) before reporting a new one.
|
|
- type: input
|
|
id: page
|
|
attributes:
|
|
label: Documentation URL
|
|
description: |
|
|
Does this issue relate to a particular page in the [online documentation](https://docs.micropython.org/en/latest/)? If yes, please paste the URL of the page:
|
|
placeholder: |
|
|
https://docs.micropython.org/en/latest/
|
|
- type: textarea
|
|
id: version
|
|
attributes:
|
|
label: Description
|
|
description: |
|
|
Please describe what was missing from the documentation and/or what was incorrect/incomplete.
|
|
validations:
|
|
required: true
|
|
- type: dropdown
|
|
id: code-of-conduct
|
|
attributes:
|
|
label: Code of Conduct
|
|
description: |
|
|
Do you agree to follow the MicroPython [Code of Conduct](https://github.com/micropython/micropython/blob/master/CODEOFCONDUCT.md) to ensure a safe and respectful space for everyone?
|
|
options:
|
|
- "Yes, I agree"
|
|
multiple: true
|
|
validations:
|
|
required: true
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Thanks for taking the time to help improve MicroPython.
|