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

Commit ff31171

Browse files
authored
Update .github
1 parent 9e438a1 commit ff31171

File tree

1 file changed

+37
-9
lines changed

1 file changed

+37
-9
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 37 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,24 +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.13) or Platform.io version
39-
* `ESP8266`,`ESP32` or `STM32` Core Version (e.g. ESP8266 core v2.7.4, ESP32 v1.0.5 or STM32 v1.9.0)
38+
* Arduino IDE version (e.g. 1.8.16) or Platform.io version
39+
* `STM32` Core Version (e.g. STM32 core v2.3.0)
40+
* Board type and relevant info
4041
* Contextual information (e.g. what you were trying to achieve)
4142
* Simplest possible steps to reproduce
4243
* Anything that might be relevant in your opinion, such as:
4344
* Operating system (Windows, Ubuntu, etc.) and the output of `uname -a`
4445
* Network configuration
45-
46+
47+
4648
### Example
4749

4850
```
49-
Arduino IDE version: 1.8.13
50-
ESP32 Core Version 1.0.5
51+
Arduino IDE version: 1.8.16
52+
STM32 Core Version 2.3.0
53+
Nucleo-144 STM32H7 NUCLEO_H743ZI2
5154
OS: Ubuntu 20.04 LTS
52-
Linux xy-Inspiron-3593 5.4.0-66-generic #74-Ubuntu SMP Wed Jan 27 22:54:38 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux
55+
Linux xy-Inspiron-3593 5.15.0-52-generic #58~20.04.1-Ubuntu SMP Thu Oct 13 13:09:46 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
5356
5457
Context:
55-
I encountered an endless loop while trying to connect to Local WiFi.
58+
I encountered a crash while using this library
5659
5760
Steps to reproduce:
5861
1. ...
@@ -61,6 +64,31 @@ Steps to reproduce:
6164
4. ...
6265
```
6366

64-
### 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/STM32_PWM/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/STM32_PWM_GitHub/
87+
xy@xy-Inspiron-3593:~/Arduino/xy/STM32_PWM_GitHub$
88+
```
89+
90+
2. Issue astyle command
6591

66-
Add any other context about the problem here.
92+
```
93+
xy@xy-Inspiron-3593:~/Arduino/xy/STM32_PWM_GitHub$ bash utils/restyle.sh
94+
```

0 commit comments

Comments
 (0)