From: Melissa LeBlanc-Williams Date: Thu, 7 Sep 2023 23:26:56 +0000 (-0700) Subject: Add issue templates and update prec-ommit config X-Git-Tag: 8.22.0^2~5 X-Git-Url: https://git.ayoreis.com/Adafruit_Blinka-hackapet.git/commitdiff_plain/10e202d4ccd117b27a8763d37d22462a83d60fa4 Add issue templates and update prec-ommit config --- diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..3e24c9c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,50 @@ +# SPDX-FileCopyrightText: 2023 Melissa LeBlanc-Williams for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: 🐞 Bug Report +description: Create a bug report to help us improve +labels: + - bug +body: + - type: markdown + attributes: + value: >- + Thanks for taking the time to fill out this bug report! + Now that you have encountered a bug... you can file a report for it. + - type: input + id: board + attributes: + label: Board Name + description: Which board are you using? + placeholder: e.g. Raspberry Pi 4 + validations: + required: false + - type: textarea + id: steps + attributes: + label: Steps + description: Please mention the steps needed to replicate the issue. + placeholder: | + 1. SSH into the board... + 2. Enter the following folder... + 3. Run the following command... + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + description: Optionally, describe the bug in more detail. + placeholder: | + - Error while using... + - Only happens when... + - Might be related to #64... + - type: textarea + id: more-info + attributes: + label: Additional information + description: >- + Optionally, add any other information like screenshot of the page. + If you have already done some debugging, mention it here. + If you have some code or logs, you can paste it here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..9521274 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +# SPDX-FileCopyrightText: 2023 Melissa LeBlanc-Williams for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +contact_links: + - name: 🔗 Adafruit Forum + url: https://forums.adafruit.com/ + about: Official Adafruit technical support forum. Good for getting help on getting a project working. + - name: 🔗 Adafruit Discord + url: https://adafru.it/discord + about: Unofficial chat with many helpful folks and normally prompt replies. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..479fb85 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,15 @@ + +--- +name: 🚀 Feature Request +about: Suggest an idea for this project +title: '' +labels: 'enhancement' +assignees: '' + +--- + + diff --git a/.github/ISSUE_TEMPLATE/new_board_request.md b/.github/ISSUE_TEMPLATE/new_board_request.md new file mode 100644 index 0000000..f3658d5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new_board_request.md @@ -0,0 +1,15 @@ + +--- +name: 🚀 New Board Request +about: Request Support for a New Board +title: '' +labels: 'New Board Request' +assignees: '' + +--- + + diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 08256d8..033f259 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,22 +4,21 @@ repos: - repo: https://github.com/python/black - rev: 22.3.0 + rev: 23.3.0 hooks: - id: black - additional_dependencies: ['click==8.0.4'] - repo: https://github.com/fsfe/reuse-tool - rev: v0.12.1 + rev: v1.1.2 hooks: - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v2.3.0 + rev: v4.4.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.11.1 + rev: v2.17.4 hooks: - id: pylint name: pylint (library code) diff --git a/src/board.py b/src/board.py index b7775d7..3c18c18 100644 --- a/src/board.py +++ b/src/board.py @@ -358,8 +358,11 @@ elif board_id is None: f""" {package[0]} version {package[1]} was unable to identify the board and/or microcontroller running the {platform.system()} platform. Please be sure you - have the latest packages running: + have the latest packages by running: 'pip3 install --upgrade adafruit-blinka adafruit-platformdetect' + + If you are running the latest package, your board may not yet be supported. Please + open a New Issue on GitHub: https://github.com/adafruit/Adafruit_Blinka/issues """ )