diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index 15186fd5c1..0000000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -1 +0,0 @@ -github: micropython diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 1ec6c7067f..24f61c4a1b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -6,6 +6,9 @@ body: attributes: value: | Please provide as much detail as you can, it really helps us find and fix bugs faster. + #### "Security" bugs + + [This is open-source software written by hobbyists](https://gitlab.gnome.org/GNOME/libxml2/-/commit/35d04a0848d8648807672e2ac1ba73ff7bbaee3a), maintained by a single volunteer, badly tested, written in a memory-unsafe language and full of security bugs. It is foolish to use this software to process untrusted data. As such, we treat security issues like any other bug. There is no facility for privately submitting a security report and security reports won't be prioritized. #### Not a bug report? diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index f3662464da..c1eb5ca2ce 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,11 +1,8 @@ blank_issues_enabled: false contact_links: - - name: MicroPython GitHub Discussions - url: https://github.com/orgs/micropython/discussions - 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. + - name: GitHub Discussions + url: https://github.com/orgs/m68k-micropython/discussions + about: Community discussion about all things m68k MicroPython. This is the best place to start if you have questions about using MicroPython on a mac or getting started with m68k MicroPython development. - name: MicroPython Documentation url: https://docs.micropython.org/ - about: Documentation for using and working with MicroPython and libraries. - - name: MicroPython Downloads - url: https://micropython.org/download/ - about: Pre-built firmware and information for most supported boards. + about: Documentation for using and working with (upstream) MicroPython and libraries. diff --git a/.github/ISSUE_TEMPLATE/documentation.yml b/.github/ISSUE_TEMPLATE/documentation.yml deleted file mode 100644 index 93051e51c8..0000000000 --- a/.github/ISSUE_TEMPLATE/documentation.yml +++ /dev/null @@ -1,46 +0,0 @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 7d5162a32a..3a33df5cb9 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,47 +1,39 @@ name: Feature request -description: Request a feature or improvement +description: Request a feature or improvement in m68k MicroPython labels: ['enhancement'] body: - type: markdown attributes: value: | - This form is for requesting features or improvements in MicroPython. + This form is for requesting features or improvements in m68k MicroPython. + #### Understand that m68k MicroPython is of alpha quality + + Many desirable features are missing or incomplete. This project will only be successful if a community of interested folks work together to create useful software. + #### Get feedback first - Before submitting a new feature idea here, suggest starting a discussion on [Discord](https://discord.gg/RB8HZSAExQ) or [GitHub Discussions](https://github.com/orgs/micropython/discussions/) to get early feedback from the community and maintainers. + Before submitting a new feature idea here, consider starting a discussion on [GitHub Discussions](https://github.com/orgs/m68k-micropython/discussions) to get early feedback from the community. - #### Not a MicroPython core feature? + #### Not a m68k MicroPython core feature? - * If you have a question \"How Do I ...?\", please post it on GitHub Discussions or Discord instead of here. + * If it's a feature that would make sense for MicroPython and other MicroPython derivatives, please start upstream with [the original MicroPython project](https://github.com/orgs/micropython/discussions). + * If you have a question \"How Do I ...?\", please post it on GitHub Discussions instead of here. * Could this feature be implemented as a pure Python library? If so, please open the request on the [micropython-lib repository](https://github.com/micropython/micropython-lib/issues) instead. #### Existing issue? - * Please search for [existing issues](https://github.com/micropython/micropython/issues) before opening a new one. + * Please search for [existing issues](https://github.com/m68k-micropython/micropython/issues) before opening a new one. - type: textarea id: feature attributes: label: Description description: | - Describe the feature you'd like to see added to MicroPython. What does this feature enable and why is it useful? - - * For core Python features, where possible please include a link to the relevant PEP or CPython documentation. - * 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. - * For features for existing ports (e.g. new peripherals or microcontroller features), please describe which port(s) it applies to, and whether this is could be an extension to the machine API or a port-specific module? - * For drivers (e.g. for external hardware), please link to datasheets and/or existing drivers from other sources. + Describe the feature you'd like to see added to m68k MicroPython. What does this feature enable and why is it useful? If there is an existing discussion somewhere about this feature, please add a link to it as well. validations: required: true - - type: textarea - id: size - attributes: - label: Code Size - description: | - MicroPython aims to strike a balance between functionality and code size. Can this feature be optionally enabled? - - If you believe the usefulness of this feature would outweigh the additional code size, please explain. (It's OK to say you're unsure here, we're happy to discuss this with you.) - type: dropdown id: implementation attributes: @@ -49,11 +41,10 @@ body: description: | What is your suggestion for implementing this feature? - (See also: [How to sponsor](https://github.com/sponsors/micropython#sponsors), [How to submit a Pull Request](https://github.com/micropython/micropython/wiki/ContributorGuidelines).) + (See also: [How to submit a Pull Request](https://github.com/micropython/micropython/wiki/ContributorGuidelines).) options: - - I hope the MicroPython maintainers or community will implement this feature + - I hope the m68k MicroPython community will implement this feature - I intend to implement this feature and would submit a Pull Request if desirable - - I would like to sponsor development of this feature multiple: true validations: required: true @@ -71,4 +62,4 @@ body: - type: markdown attributes: value: | - Thanks for taking the time to suggest improvements for MicroPython. + Thanks for taking the time to suggest improvements for m68k MicroPython. diff --git a/.github/ISSUE_TEMPLATE/security.yml b/.github/ISSUE_TEMPLATE/security.yml deleted file mode 100644 index 57c2a5885e..0000000000 --- a/.github/ISSUE_TEMPLATE/security.yml +++ /dev/null @@ -1,60 +0,0 @@ -name: Security report -description: Report a security issue or vulnerability in MicroPython -labels: ["security"] -body: - - type: markdown - attributes: - value: | - This form is for reporting security issues in MicroPython that are not readily exploitable. - - 1. For issues that are readily exploitable or have high impact, please email contact@micropython.org instead. - 1. If this is a question about security, please ask it in [Discussions](https://github.com/orgs/micropython/discussions/) or [Discord](https://discord.gg/RB8HZSAExQ) instead. - - #### Existing issue? - - * Please search for [existing issues](https://github.com/micropython/micropython/issues) before reporting a new one. - - - type: input - id: port-board-hw - attributes: - label: Port, board and/or hardware - description: | - Which MicroPython port(s) and board(s) are you using? - placeholder: | - esp32 port, ESP32-Duper board. - - type: textarea - id: version - attributes: - label: MicroPython version - description: | - To find the version: - - 1. Open a serial REPL. - 2. Type Ctrl-B to see the startup message. - 3. Copy-paste that output here. - - If the version or configuration is modified from the official MicroPython releases or the master branch, please tell us the details of this as well. - placeholder: | - MicroPython v6.28.3 on 2029-01-23; PyBoard 9 with STM32F9 - - type: textarea - id: report - attributes: - label: Issue Report - description: | - Please provide a clear and concise description of the security issue. - - * What does this issue allow an attacker to do? - * How does the attacker exploit this issue? - 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 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index e11cebddb3..982d5ccbb3 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,5 +1,5 @@