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

Commit ffc217e

Browse files
authored
Update .github
1 parent 3886efb commit ffc217e

File tree

4 files changed

+158
-0
lines changed

4 files changed

+158
-0
lines changed

ISSUE_TEMPLATE/bug_report.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
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+
* `Teensyduino` Core Version (e.g. Teensy core v1.57)
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+
Teensyduino Core Version 1.57
52+
OS: Ubuntu 20.04 LTS
53+
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
54+
55+
Context:
56+
I encountered a crash while using this library
57+
58+
Steps to reproduce:
59+
1. ...
60+
2. ...
61+
3. ...
62+
4. ...
63+
```
64+
65+
---
66+
67+
### Sending Feature Requests
68+
69+
Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful.
70+
71+
There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/Teensy_PWM/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them.
72+
73+
---
74+
75+
### Sending Pull Requests
76+
77+
Pull Requests with changes and fixes are also welcome!
78+
79+
Please use the `astyle` to reformat the updated library code as follows (demo for Ubuntu Linux)
80+
81+
1. Change directory to the library GitHub
82+
83+
```
84+
xy@xy-Inspiron-3593:~$ cd Arduino/xy/Teensy_PWM_GitHub/
85+
xy@xy-Inspiron-3593:~/Arduino/xy/Teensy_PWM_GitHub$
86+
```
87+
88+
2. Issue astyle command
89+
90+
```
91+
xy@xy-Inspiron-3593:~/Arduino/xy/Teensy_PWM_GitHub$ bash utils/restyle.sh
92+
```

ISSUE_TEMPLATE/feature_request.md

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.

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+

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)