Skip to content

Commit bc42db4

Browse files
jimmodpgeorge
jimmo
authored and
dpgeorge
committed
github/ISSUE_TEMPLATE: Add GitHub issue templates and external links.
When opening a new issue the following selection is now shown: - Bug reports - Feature requests - Security issue - Documentation issue - Link to forum - Link to docs - Link to downloads
1 parent 079f3e5 commit bc42db4

5 files changed

Lines changed: 92 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Bug report
3+
about: Report an issue
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
* Remove all placeholder text below before submitting.
11+
12+
* Please search existing issues before raising a new issue. For questions about MicroPython or for help using MicroPython, please see the MicroPython Forum -- https://forum.micropython.org/
13+
14+
* In your issue, please include a clear and concise description of what the bug is, the expected output, and how to replicate it.
15+
16+
* If this issue involves external hardware, please include links to relevant datasheets and schematics.
17+
18+
* If you are seeing code being executed incorrectly, please provide a minimal example and expected output (e.g. comparison to CPython).
19+
20+
* For build issues, please include full details of your environment, compiler versions, command lines, and build output.
21+
22+
* Please provide as much information as possible about the version of MicroPython you're running, such as:
23+
- firmware file name
24+
- git commit hash and port/board
25+
- version information shown in the REPL (hit Ctrl-B to see the startup message)

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: MicroPython Forum
4+
url: https://forum.micropython.org/
5+
about: Community discussion about all things MicroPython. This is the best place to start if you have questions about using MicroPython or getting started with MicroPython development.
6+
- name: MicroPython Documentation
7+
url: https://docs.micropython.org/
8+
about: Documentation for using and working with MicroPython and libraries.
9+
- name: MicroPython Downloads
10+
url: https://micropython.org/download/
11+
about: Pre-built firmware and information for most supported boards.

‎.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Documentation issue
3+
about: Report areas of the documentation or examples that need improvement
4+
title: 'docs: '
5+
labels: documentation
6+
assignees: ''
7+
8+
---
9+
10+
* Remove all placeholder text below before submitting.
11+
12+
* Please search existing issues before raising a new issue. For questions about MicroPython or for help using MicroPython, please see the MicroPython Forum -- https://forum.micropython.org/
13+
14+
* Describe what was missing from the documentation and/or what was incorrect/incomplete.
15+
16+
* If possible, please link to the relevant page on https://docs.micropython.org/

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Feature request
3+
about: Request a feature or improvement
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
* Remove all placeholder text below before submitting.
11+
12+
* Please search existing issues before raising a new issue. For questions about MicroPython or for help using MicroPython, please see the MicroPython Forum -- https://forum.micropython.org/
13+
14+
* Describe the feature you'd like to see added to MicroPython. In particular, what does this feature enable and why is it useful. MicroPython aims to strike a balance between functionality and code size, so please consider whether this feature can be optionally enabled and whether it can be provided in other ways (e.g. pure-Python library).
15+
16+
* For core Python features, where possible please include a link to the relevant PEP.
17+
18+
* For new architectures / ports / boards, please provide links to relevant documentation, specifications, and toolchains. Any information about the popularity and unique features about this hardware would also be useful.
19+
20+
* For features for existing ports (e.g. new peripherals or microcontroller features), please describe which port(s) it applies too, and whether this is could be an extension to the machine API or a port-specific module?
21+
22+
* For drivers (e.g. for external hardware), please link to datasheets and/or existing drivers from other sources.
23+
24+
* Who do you expect will implement the feature you are requesting? Would you be willing to sponsor this work?

‎.github/ISSUE_TEMPLATE/security.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Security report
3+
about: Report a security issue or vunerability in MicroPython
4+
title: ''
5+
labels: security
6+
assignees: ''
7+
8+
---
9+
10+
* Remove all placeholder text before submitting the new issue.
11+
12+
* If you need to raise this issue privately with the MicroPython team, please email contact@micropython.org instead.
13+
14+
* Include a clear and concise description of what the security issue is.
15+
16+
* What does this issue allow an attacker to do?

0 commit comments

Comments
 (0)