Skip to content

Commit 29472c2

Browse files
committed
Add Question Template
1 parent a88bed6 commit 29472c2

File tree

2 files changed

+104
-0
lines changed

2 files changed

+104
-0
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Source:
2+
# https://github.com/Tinyu-Zhao/M5-Depends/blob/main/.github/ISSUE_TEMPLATE/bug-report.yml
3+
# See:
4+
# https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
5+
6+
name: Bug report
7+
description: Report a problem with the code in this repository.
8+
labels:
9+
- "type: bug"
10+
body:
11+
- type: markdown
12+
attributes:
13+
value: "Thank you for opening an issue on an M5Stack Arduino library repository.\n\
14+
To improve the speed of resolution please review the following guidelines and common troubleshooting steps below before creating the issue:\n\
15+
Do not use GitHub issues for troubleshooting projects and issues. Instead use the forums at https://community.m5stack.com to ask questions and troubleshoot why something isn't working as expected. In many cases the problem is a common issue that you will more quickly receive help from the forum community. GitHub issues are meant for known defects in the code. If you don't know if there is a defect in the code then start with troubleshooting on the forum first."
16+
- type: textarea
17+
id: description
18+
attributes:
19+
label: Describe the bug
20+
description: A clear and concise description of what the bug is.
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: reproduce
25+
attributes:
26+
label: To reproduce
27+
description: Provide the specific set of steps we can follow to reproduce the problem.
28+
placeholder: |
29+
1. In this environment...
30+
2. With this config...
31+
3. Run '...'
32+
4. See error...
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: expected
37+
attributes:
38+
label: Expected behavior
39+
description: What would you expect to happen after following those instructions?
40+
validations:
41+
required: true
42+
- type: textarea
43+
id: screenshots
44+
attributes:
45+
label: Screenshots
46+
description: If applicable, add screenshots to help explain your problem.
47+
validations:
48+
required: false
49+
- type: textarea
50+
id: information
51+
attributes:
52+
label: Environment
53+
description: |
54+
If applicable, add screenshots to help explain your problem.
55+
examples:
56+
- **OS**: Ubuntu 20.04
57+
- **IDE & IDE Version**: Arduino 1.8.19 Or Platform IO v2.5.0
58+
- **Repository Version**: 0.4.0
59+
value: |
60+
- OS:
61+
- IDE &IDE Version:
62+
- Repository Version:
63+
validations:
64+
required: false
65+
- type: textarea
66+
id: additional
67+
attributes:
68+
label: Additional context
69+
description: Add any additional information here.
70+
validations:
71+
required: false
72+
- type: checkboxes
73+
id: checklist
74+
attributes:
75+
label: Issue checklist
76+
description: Please double-check that you have done each of the following things before submitting the issue.
77+
options:
78+
- label: I searched for previous reports in [the issue tracker](https://github.com/m5stack/M5Stack/issues?q=)
79+
required: true
80+
- label: My report contains all necessary details
81+
required: true
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: clang-format Check
2+
on: [push, pull_request]
3+
jobs:
4+
formatting-check:
5+
name: Formatting Check
6+
runs-on: ubuntu-latest
7+
strategy:
8+
matrix:
9+
path:
10+
- check: './' # path to include
11+
exclude: '' # path to exclude
12+
# - check: 'src'
13+
# exclude: ''
14+
# - check: 'examples'
15+
# exclude: ''
16+
steps:
17+
- uses: actions/checkout@v2
18+
- name: Run clang-format style check for C/C++/Protobuf programs.
19+
uses: jidicula/[email protected]
20+
with:
21+
clang-format-version: '13'
22+
check-path: ${{ matrix.path['check'] }}
23+
exclude-regex: ${{ matrix.path['exclude'] }}

0 commit comments

Comments
 (0)