]> Repositories - Adafruit_Blinka-hackapet.git/commitdiff
Add issue templates and update prec-ommit config
authorMelissa LeBlanc-Williams <melissa@adafruit.com>
Thu, 7 Sep 2023 23:26:56 +0000 (16:26 -0700)
committerMelissa LeBlanc-Williams <melissa@adafruit.com>
Thu, 7 Sep 2023 23:26:56 +0000 (16:26 -0700)
.github/ISSUE_TEMPLATE/bug_report.yml [new file with mode: 0644]
.github/ISSUE_TEMPLATE/config.yml [new file with mode: 0644]
.github/ISSUE_TEMPLATE/feature_request.md [new file with mode: 0644]
.github/ISSUE_TEMPLATE/new_board_request.md [new file with mode: 0644]
.pre-commit-config.yaml
src/board.py

diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644 (file)
index 0000000..3e24c9c
--- /dev/null
@@ -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 (file)
index 0000000..9521274
--- /dev/null
@@ -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 (file)
index 0000000..479fb85
--- /dev/null
@@ -0,0 +1,15 @@
+<!--
+SPDX-FileCopyrightText: 2023 Melissa LeBlanc-Williams for Adafruit Industries
+SPDX-License-Identifier: MIT
+-->
+---
+name: 🚀 Feature Request
+about: Suggest an idea for this project
+title: ''
+labels: 'enhancement'
+assignees: ''
+
+---
+
+<!-- We keep adding new features and enhancements to CircuitPython 🚀
+and would love ❤ to see what new challenge you have got for us... 🙂 -->
diff --git a/.github/ISSUE_TEMPLATE/new_board_request.md b/.github/ISSUE_TEMPLATE/new_board_request.md
new file mode 100644 (file)
index 0000000..f3658d5
--- /dev/null
@@ -0,0 +1,15 @@
+<!--
+SPDX-FileCopyrightText: 2023 Melissa LeBlanc-Williams for Adafruit Industries
+SPDX-License-Identifier: MIT
+-->
+---
+name: 🚀 New Board Request
+about: Request Support for a New Board
+title: ''
+labels: 'New Board Request'
+assignees: ''
+
+---
+
+<!-- We keep growing Blinka 🚀 and would love ❤ to
+ see what new boards you would like supported... 🙂 -->
index 08256d87f234093a2845e281d9940a89c41e9e78..033f2594bb1698052d9175183a1e10c394a9da5d 100644 (file)
@@ -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)
index b7775d734074d16fadb051078acfc37d01561346..3c18c18f838a530826d7b7aee5b4faaadadc6786 100644 (file)
@@ -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
         """
     )