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

Commit 3886efb

Browse files
khoih-progkhoih-prog
authored
Update .github 
1 parent f2cb272 commit 3886efb

File tree

4 files changed

+127
-24
lines changed

4 files changed

+127
-24
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 76 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,88 @@ assignees: ''
77

88
---
99

10-
**Describe the bug**
10+
### Describe the bug
11+
1112
A clear and concise description of what the bug is.
1213

13-
**To Reproduce**
14-
Steps to reproduce the behavior:
15-
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
18-
4. See error
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
1923

20-
**Expected behavior**
2124
A clear and concise description of what you expected to happen.
2225

23-
**Screenshots**
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+
2432
If applicable, add screenshots to help explain your problem.
2533

26-
**Desktop (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
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+
* `NRF52` Core Version (e.g. Adafruit NRF52 core v1.3.0, Seeed nRF52 core v1.0.0)
40+
* Contextual information (e.g. what you were trying to achieve)
41+
* Simplest possible steps to reproduce
42+
* Anything that might be relevant in your opinion, such as:
43+
* Operating system (Windows, Ubuntu, etc.) and the output of `uname -a`
44+
* Network configuration
45+
46+
47+
### Example
48+
49+
```
50+
Arduino IDE version: 1.8.19
51+
Adafruit NRF52 Core Version 1.3.0
52+
NRF52840_ITSYBITSY
53+
OS: Ubuntu 20.04 LTS
54+
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
55+
56+
Context:
57+
I encountered a crash while using this library
58+
59+
Steps to reproduce:
60+
1. ...
61+
2. ...
62+
3. ...
63+
4. ...
64+
```
65+
66+
---
67+
68+
### Sending Feature Requests
69+
70+
Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful.
71+
72+
There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/nRF52_PWM/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them.
73+
74+
---
75+
76+
### Sending Pull Requests
77+
78+
Pull Requests with changes and fixes are also welcome!
79+
80+
Please use the `astyle` to reformat the updated library code as follows (demo for Ubuntu Linux)
81+
82+
1. Change directory to the library GitHub
83+
84+
```
85+
xy@xy-Inspiron-3593:~$ cd Arduino/xy/nRF52_PWM_GitHub/
86+
xy@xy-Inspiron-3593:~/Arduino/xy/nRF52_PWM_GitHub$
87+
```
88+
89+
2. Issue astyle command
3090

31-
**Smartphone (please complete the following information):**
32-
- Device: [e.g. iPhone6]
33-
- OS: [e.g. iOS8.1]
34-
- Browser [e.g. stock browser, safari]
35-
- Version [e.g. 22]
91+
```
92+
xy@xy-Inspiron-3593:~/Arduino/xy/nRF52_PWM_GitHub$ bash utils/restyle.sh
93+
```
3694

37-
**Additional context**
38-
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,18 @@ assignees: ''
77

88
---
99

10-
**Is your feature request related to a problem? Please describe.**
10+
### Is your feature request related to a problem? Please describe.
11+
1112
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1213

13-
**Describe the solution you'd like**
14+
### Describe the solution you'd like
15+
1416
A clear and concise description of what you want to happen.
1517

16-
**Describe alternatives you've considered**
18+
### Describe alternatives you've considered
19+
1720
A clear and concise description of any alternative solutions or features you've considered.
1821

19-
**Additional context**
22+
### Additional context
23+
2024
Add any other context or screenshots about the feature request here.

‎.github/stale.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Configuration for probot-stale - https://github.com/probot/stale
2+
3+
daysUntilStale: 60
4+
daysUntilClose: 14
5+
limitPerRun: 30
6+
staleLabel: stale
7+
exemptLabels:
8+
- pinned
9+
- security
10+
- "to be implemented"
11+
- "for reference"
12+
- "move to PR"
13+
- "enhancement"
14+
15+
only: issues
16+
onlyLabels: []
17+
exemptProjects: false
18+
exemptMilestones: false
19+
exemptAssignees: false
20+
21+
markComment: >
22+
[STALE_SET] This issue has been automatically marked as stale because it has not had
23+
recent activity. It will be closed in 14 days if no further activity occurs. Thank you
24+
for your contributions.
25+
26+
unmarkComment: >
27+
[STALE_CLR] This issue has been removed from the stale queue. Please ensure activity to keep it openin the future.
28+
29+
closeComment: >
30+
[STALE_DEL] This stale issue has been automatically closed. Thank you for your contributions.
31+

‎.github/workflows/auto-github-actions.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: auto-github-actions
2+
on: [push]
3+
jobs:
4+
check-bats-version:
5+
runs-on: ubuntu-latest
6+
steps:
7+
- uses: actions/checkout@v2
8+
- uses: actions/setup-node@v2
9+
with:
10+
node-version: '14'
11+
- run: npm install -g bats
12+
- run: bats -v

0 commit comments

Comments
 (0)