Skip to content
This repository was archived by the owner on Jan 29, 2023. It is now read-only.

Commit 72c04b0

Browse files
authored
Update .github
1 parent d23cc39 commit 72c04b0

File tree

1 file changed

+39
-11
lines changed

1 file changed

+39
-11
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+39-11
Original file line numberDiff line numberDiff line change
@@ -35,26 +35,27 @@ If applicable, add screenshots to help explain your problem.
3535

3636
Please ensure to specify the following:
3737

38-
* Arduino IDE version (e.g. 1.8.15) or Platform.io version
39-
* `RP2040` Core Version (e.g. Arduino-mbed RP2040 v2.1.0 or arduino-pico core v1.8.4)
40-
* `RP2040` Board type (e.g. NANO_RP2040_CONNECT, RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040, GENERIC_RP2040, etc.)
38+
* Arduino IDE version (e.g. 1.8.19) or Platform.io version
39+
* `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)
40+
* `RP2040` Board type (e.g. Nano_RP2040_Connect, RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040, GENERIC_RP2040, etc.)
4141
* Contextual information (e.g. what you were trying to achieve)
4242
* Simplest possible steps to reproduce
4343
* Anything that might be relevant in your opinion, such as:
4444
* Operating system (Windows, Ubuntu, etc.) and the output of `uname -a`
4545
* Network configuration
46-
46+
47+
4748
### Example
4849

4950
```
50-
Arduino IDE version: 1.8.15
51-
Arduino-mbed RP2040 v2.1.0
52-
NANO_RP2040_CONNECT Module
51+
Arduino IDE version: 1.8.19
52+
Arduino mbed_rp2040 core v3.4.1
53+
RASPBERRY_PI_PICO board
5354
OS: Ubuntu 20.04 LTS
54-
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
55+
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
5556
5657
Context:
57-
I encountered a crash while using TimerInterrupt.
58+
I encountered a crash while using this library
5859
5960
Steps to reproduce:
6061
1. ...
@@ -63,6 +64,33 @@ Steps to reproduce:
6364
4. ...
6465
```
6566

66-
### Additional context
67+
---
68+
69+
### Sending Feature Requests
70+
71+
Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful.
72+
73+
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.
74+
75+
---
76+
77+
### Sending Pull Requests
78+
79+
Pull Requests with changes and fixes are also welcome!
80+
81+
Please use the `astyle` to reformat the updated library code as follows (demo for Ubuntu Linux)
82+
83+
1. Change directory to the library GitHub
84+
85+
```
86+
xy@xy-Inspiron-3593:~$ cd Arduino/xy/RP2040_SD_GitHub/
87+
xy@xy-Inspiron-3593:~/Arduino/xy/RP2040_SD_GitHub$
88+
```
89+
90+
2. Issue astyle command
91+
92+
```
93+
xy@xy-Inspiron-3593:~/Arduino/xy/RP2040_SD_GitHub$ bash utils/restyle.sh
94+
```
95+
6796

68-
Add any other context about the problem here.

0 commit comments

Comments
 (0)