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

Commit baddaab

Browse files
authored
Update .github
1 parent 68b3db5 commit baddaab

File tree

2 files changed

+119
-0
lines changed

2 files changed

+119
-0
lines changed
Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
### Describe the bug
11+
12+
A clear and concise description of what the bug is.
13+
14+
### Steps to Reproduce
15+
16+
Steps to reproduce the behavior. Including the [MRE](https://stackoverflow.com/help/minimal-reproducible-example) sketches
17+
18+
### Expected behavior
19+
20+
A clear and concise description of what you expected to happen.
21+
22+
### Actual behavior
23+
24+
A clear and concise description of what you expected to happen.
25+
26+
### Debug and AT-command log (if applicable)
27+
28+
A clear and concise description of what you expected to happen.
29+
30+
### Screenshots
31+
32+
If applicable, add screenshots to help explain your problem.
33+
34+
### Information
35+
36+
Please ensure to specify the following:
37+
38+
* Arduino IDE version (e.g. 1.8.19) or Platform.io version
39+
* `nRF52840 mbed` Core Version (e.g. Arduino mbed_nano core v3.4.1, Seeeduino mbed core v2.7.2)
40+
* `nRF52840-based Nano_33_BLE` Board type (e.g. Nano_33_BLE, Nano_33_BLE_Sense, SEEED_XIAO_NRF52840 and SEEED_XIAO_NRF52840_SENSE, etc.)
41+
* Contextual information (e.g. what you were trying to achieve)
42+
* Simplest possible steps to reproduce
43+
* Anything that might be relevant in your opinion, such as:
44+
* Operating system (Windows, Ubuntu, etc.) and the output of `uname -a`
45+
* Network configuration
46+
47+
48+
### Example
49+
50+
```
51+
Arduino IDE version: 1.8.19
52+
Arduino mbed_nano core v3.4.1
53+
Nano_33_BLE board
54+
OS: Ubuntu 20.04 LTS
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
56+
57+
Context:
58+
I encountered a crash while using this library
59+
60+
Steps to reproduce:
61+
1. ...
62+
2. ...
63+
3. ...
64+
4. ...
65+
```
66+
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/nRF52_MBED_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/nRF52_MBED_PWM_GitHub/
87+
xy@xy-Inspiron-3593:~/Arduino/xy/nRF52_MBED_PWM_GitHub$
88+
```
89+
90+
2. Issue astyle command
91+
92+
```
93+
xy@xy-Inspiron-3593:~/Arduino/xy/nRF52_MBED_PWM_GitHub$ bash utils/restyle.sh
94+
```
95+
96+
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
### Is your feature request related to a problem? Please describe.
11+
12+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
13+
14+
### Describe the solution you'd like
15+
16+
A clear and concise description of what you want to happen.
17+
18+
### Describe alternatives you've considered
19+
A clear and concise description of any alternative solutions or features you've considered.
20+
21+
### Additional context
22+
23+
Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)