diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f2df98b..e020189 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -35,26 +35,27 @@ If applicable, add screenshots to help explain your problem. Please ensure to specify the following: -* Arduino IDE version (e.g. 1.8.15) or Platform.io version -* `RP2040` Core Version (e.g. Arduino-mbed RP2040 v2.1.0 or arduino-pico core v1.8.4) -* `RP2040` Board type (e.g. NANO_RP2040_CONNECT, RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040, GENERIC_RP2040, etc.) +* Arduino IDE version (e.g. 1.8.19) or Platform.io version +* `Arduino mbed_rp2040` Core Version (e.g. Arduino mbed_rp2040 core v3.4.1) or `RP2040` Core Version (e.g. RP2040 core v2.6.3) +* `RP2040` Board type (e.g. Nano_RP2040_Connect, RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040, GENERIC_RP2040, etc.) * Contextual information (e.g. what you were trying to achieve) * Simplest possible steps to reproduce * Anything that might be relevant in your opinion, such as: * Operating system (Windows, Ubuntu, etc.) and the output of `uname -a` * Network configuration - + + ### Example ``` -Arduino IDE version: 1.8.15 -Arduino-mbed RP2040 v2.1.0 -NANO_RP2040_CONNECT Module +Arduino IDE version: 1.8.19 +Arduino mbed_rp2040 core v3.4.1 +RASPBERRY_PI_PICO board OS: Ubuntu 20.04 LTS -Linux xy-Inspiron-3593 5.4.0-74-generic #83-Ubuntu SMP Sat May 8 02:35:39 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux +Linux xy-Inspiron-3593 5.15.0-53-generic #59~20.04.1-Ubuntu SMP Thu Oct 20 15:10:22 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux Context: -I encountered a crash while using TimerInterrupt. +I encountered a crash while using this library Steps to reproduce: 1. ... @@ -63,6 +64,33 @@ Steps to reproduce: 4. ... ``` -### Additional context +--- + +### Sending Feature Requests + +Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful. + +There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/RP2040_SD/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them. + +--- + +### Sending Pull Requests + +Pull Requests with changes and fixes are also welcome! + +Please use the `astyle` to reformat the updated library code as follows (demo for Ubuntu Linux) + +1. Change directory to the library GitHub + +``` +xy@xy-Inspiron-3593:~$ cd Arduino/xy/RP2040_SD_GitHub/ +xy@xy-Inspiron-3593:~/Arduino/xy/RP2040_SD_GitHub$ +``` + +2. Issue astyle command + +``` +xy@xy-Inspiron-3593:~/Arduino/xy/RP2040_SD_GitHub$ bash utils/restyle.sh +``` + -Add any other context about the problem here.