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

Commit fb4b670

Browse files
khoih-progkhoih-prog
authored
Update .github 
1 parent 82bfd30 commit fb4b670

7 files changed

+177
-23
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+78-19
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,91 @@ 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+
* Board Core Version (e.g. ESP32 core v2.0.5)
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+
Please be educated, civilized and constructive. Disrespective posts against [GitHub Code of Conduct](https://docs.github.com/en/site-policy/github-terms/github-event-code-of-conduct) will be ignored and deleted.
47+
48+
### Example
49+
50+
```
51+
Arduino IDE version: 1.8.19
52+
ESP32_DEV board
53+
ESP32 core v2.0.5
54+
OS: Ubuntu 20.04 LTS
55+
Linux xy-Inspiron-3593 5.15.0-56-generic #62~20.04.1-Ubuntu SMP Tue Nov 22 21:24:20 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
3056
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]
57+
Context:
58+
I encountered a crash while using this library
59+
Steps to reproduce:
60+
1. ...
61+
2. ...
62+
3. ...
63+
4. ...
64+
```
65+
66+
### Additional context
3667

37-
**Additional context**
3868
Add any other context about the problem here.
69+
70+
---
71+
72+
### Sending Feature Requests
73+
74+
Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful.
75+
76+
There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/ESP32_ENC_Manager/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them.
77+
78+
---
79+
80+
### Sending Pull Requests
81+
82+
Pull Requests with changes and fixes are also welcome!
83+
84+
Please use the `astyle` to reformat the updated library code as follows (demo for Ubuntu Linux)
85+
86+
1. Change directory to the library GitHub
87+
88+
```
89+
xy@xy-Inspiron-3593:~$ cd Arduino/xy/ESP32_ENC_Manager_GitHub/
90+
xy@xy-Inspiron-3593:~/Arduino/xy/ESP32_ENC_Manager_GitHub$
91+
```
92+
93+
2. Issue astyle command
94+
95+
```
96+
xy@xy-Inspiron-3593:~/Arduino/xy/ESP32_ENC_Manager_GitHub$ bash utils/restyle.sh
97+
```

‎.github/ISSUE_TEMPLATE/feature_request.md

+8-4
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/dependabot.yml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# See: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#about-the-dependabotyml-file
2+
version: 2
3+
4+
updates:
5+
# Configure check for outdated GitHub Actions actions in workflows.
6+
# See: https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot
7+
- package-ecosystem: github-actions
8+
directory: / # Check the repository's workflows under /.github/workflows/
9+
schedule:
10+
interval: daily

‎.github/stale.yml

+31
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 opening 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

+12
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@v3
8+
- uses: actions/setup-node@v3
9+
with:
10+
node-version: '14'
11+
- run: npm install -g bats
12+
- run: bats -v

‎.github/workflows/report-size-deltas.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Report Size Deltas
2+
3+
on:
4+
schedule:
5+
- cron: '*/5 * * * *'
6+
7+
jobs:
8+
report:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- name: Comment size deltas reports to PRs
13+
uses: arduino/report-size-deltas@v1
14+
with:
15+
# The name of the workflow artifact created by the "Compile Examples" workflow
16+
sketches-reports-source: sketches-reports

‎.github/workflows/spell-check.yml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Spell Check
2+
3+
on:
4+
pull_request:
5+
push:
6+
schedule:
7+
# run every Tuesday at 3 AM UTC
8+
- cron: "0 3 * * 2"
9+
workflow_dispatch:
10+
repository_dispatch:
11+
12+
jobs:
13+
spellcheck:
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- name: Checkout
18+
uses: actions/checkout@v3
19+
20+
# See: https://github.com/codespell-project/actions-codespell/blob/master/README.md
21+
- name: Spell check
22+
uses: codespell-project/actions-codespell@master

0 commit comments

Comments
 (0)