Skip to content

Commit 39505c9

Browse files
author
Simonas Ju
committed
initial commit
0 parents  commit 39505c9

18,860 files changed

Lines changed: 5040754 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.codespellrc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[codespell]
2+
skip = build,*.yuv,components/fatfs/src/*,alice.txt,*.rgb,components/wpa_supplicant/*,components/esp_wifi/*,*.pem,*/COPYING*,docs/sphinx-known-warnings.txt
3+
ignore-words-list = ser,dout,rsource,fram,inout,shs,ans,aci,unstall,unstalling,hart,wheight,wel,ot,fane,assertIn,registr,oen,parms
4+
write-changes = true

‎.editorconfig‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# EditorConfig helps developers define and maintain consistent
2+
# coding styles between different editors and IDEs
3+
# http://editorconfig.org
4+
5+
root = true
6+
7+
[*]
8+
indent_style = space
9+
indent_size = 4
10+
end_of_line = lf
11+
charset = utf-8
12+
trim_trailing_whitespace = true
13+
insert_final_newline = true
14+
15+
[{*.md,*.rst}]
16+
trim_trailing_whitespace = false
17+
18+
[{Makefile,*.mk,*.bat}]
19+
indent_style = tab
20+
indent_size = 2
21+
22+
[*.pem]
23+
insert_final_newline = false
24+
25+
[*.py]
26+
max_line_length = 119
27+
28+
[{*.cmake,CMakeLists.txt}]
29+
indent_style = space
30+
indent_size = 4
31+
max_line_length = 120
32+
33+
[{*.sh,*.yml,*.yaml}]
34+
indent_size = 2
35+
36+
[*.ini]
37+
indent_size = 2

‎.github/ISSUE_TEMPLATE/01_build_install_bug.yml‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
name: Installation or build bug report
2+
description: Report installation or build bugs
3+
labels: ['Type: Bug']
4+
body:
5+
- type: checkboxes
6+
id: checklist
7+
attributes:
8+
label: Answers checklist.
9+
description: Before submitting a new issue, please follow the checklist and try to find the answer.
10+
options:
11+
- label: I have read the documentation [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/latest/) and the issue is not addressed there.
12+
required: true
13+
- label: I have updated my IDF branch (master or release) to the latest version and checked that the issue is present there.
14+
required: true
15+
- label: I have searched the issue tracker for a similar issue and not found a similar issue.
16+
required: true
17+
- type: input
18+
id: idf_version
19+
attributes:
20+
label: IDF version.
21+
description: On which IDF version does this issue occur on? Run `git describe --tags` to find it.
22+
placeholder: ex. v3.2-dev-1148-g96cd3b75c
23+
validations:
24+
required: true
25+
- type: dropdown
26+
id: operating_system
27+
attributes:
28+
label: Operating System used.
29+
multiple: false
30+
options:
31+
- Windows
32+
- Linux
33+
- macOS
34+
validations:
35+
required: true
36+
- type: dropdown
37+
id: build
38+
attributes:
39+
label: How did you build your project?
40+
multiple: false
41+
options:
42+
- Command line with Make
43+
- Command line with CMake
44+
- Command line with idf.py
45+
- Eclipse IDE
46+
- CLion IDE
47+
- VS Code IDE
48+
- Other (please specify in More Information)
49+
validations:
50+
required: true
51+
- type: dropdown
52+
id: windows_comand_line
53+
attributes:
54+
label: If you are using Windows, please specify command line type.
55+
multiple: false
56+
options:
57+
- PowerShell
58+
- CMD
59+
validations:
60+
required: false
61+
- type: textarea
62+
id: expected
63+
attributes:
64+
label: What is the expected behavior?
65+
description: Please provide a clear and concise description of the expected behavior.
66+
placeholder: I expected it to...
67+
validations:
68+
required: true
69+
- type: textarea
70+
id: actual
71+
attributes:
72+
label: What is the actual behavior?
73+
description: Please describe actual behavior.
74+
placeholder: Instead it...
75+
validations:
76+
required: true
77+
- type: textarea
78+
id: steps
79+
attributes:
80+
label: Steps to reproduce.
81+
description: 'How do you trigger this bug? Please walk us through it step by step. If this is build bug, please attach sdkconfig file (from your project folder). Please attach your code here.'
82+
value: |
83+
1. Step
84+
2. Step
85+
3. Step
86+
...
87+
validations:
88+
required: true
89+
- type: textarea
90+
id: debug_logs
91+
attributes:
92+
label: Build or installation Logs.
93+
description: Build or installation log goes here, should contain the backtrace, as well as the reset source if it is a crash.
94+
placeholder: Your log goes here.
95+
render: plain
96+
validations:
97+
required: false
98+
- type: textarea
99+
id: diag
100+
attributes:
101+
label: Diagnostic report archive.
102+
description: |
103+
Diagnostic report for ESP-IDF created using [idf.py diag](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-diag.html) or [esp-idf-diag](https://github.com/espressif/esp-idf-diag). The `idf.py diag` command is available beginning with ESP-IDF version 5.5. For older versions, you may want to consider using the `esp-idf-diag` command.
104+
105+
In your project directory, execute the following command:
106+
107+
Using `idf.py diag`
108+
1. idf.py diag
109+
110+
Using `esp-idf-diag`
111+
1. pip install esp-idf-diag
112+
2. esp-idf-diag create
113+
114+
Once the report is generated, the tool will guide you with the next steps.
115+
placeholder: Please attach the diagnostic report zip file here.
116+
validations:
117+
required: false
118+
- type: textarea
119+
id: more-info
120+
attributes:
121+
label: More Information.
122+
description: Do you have any other information from investigating this?
123+
placeholder: ex. I tried on my friend's Windows 10 PC and the command works there.
124+
validations:
125+
required: false

‎.github/ISSUE_TEMPLATE/02_runtime_bug.yml‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
name: Runtime bug report
2+
description: Report runtime bugs
3+
labels: ['Type: Bug']
4+
body:
5+
- type: checkboxes
6+
id: checklist
7+
attributes:
8+
label: Answers checklist.
9+
description: Before submitting a new issue, please follow the checklist and try to find the answer.
10+
options:
11+
- label: I have read the documentation [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/latest/) and the issue is not addressed there.
12+
required: true
13+
- label: I have updated my IDF branch (master or release) to the latest version and checked that the issue is present there.
14+
required: true
15+
- label: I have searched the issue tracker for a similar issue and not found a similar issue.
16+
required: true
17+
- type: input
18+
id: idf_version
19+
attributes:
20+
label: IDF version.
21+
description: On which IDF version does this issue occur on? Run `git describe --tags` to find it.
22+
placeholder: ex. v3.2-dev-1148-g96cd3b75c
23+
validations:
24+
required: true
25+
- type: input
26+
id: chip_revision
27+
attributes:
28+
label: Espressif SoC revision.
29+
description: On which Espressif SoC revision does your application run on? Run `esptool chip-id` (or `esptool.py chip_id` for ESP-IDF v5.5 and older) to find it.
30+
placeholder: ex. ESP32-C3 (QFN32) (revision v0.3)
31+
validations:
32+
required: true
33+
- type: dropdown
34+
id: operating_system
35+
attributes:
36+
label: Operating System used.
37+
multiple: false
38+
options:
39+
- Windows
40+
- Linux
41+
- macOS
42+
validations:
43+
required: true
44+
- type: dropdown
45+
id: build
46+
attributes:
47+
label: How did you build your project?
48+
multiple: false
49+
options:
50+
- Command line with Make
51+
- Command line with CMake
52+
- Command line with idf.py
53+
- Eclipse IDE
54+
- CLion IDE
55+
- VS Code IDE
56+
- Other (please specify in More Information)
57+
validations:
58+
required: true
59+
- type: dropdown
60+
id: windows_comand_line
61+
attributes:
62+
label: If you are using Windows, please specify command line type.
63+
multiple: false
64+
options:
65+
- PowerShell
66+
- CMD
67+
validations:
68+
required: false
69+
- type: input
70+
id: devkit
71+
attributes:
72+
label: Development Kit.
73+
description: On which Development Kit does this issue occur on?
74+
placeholder: ex. ESP32-Wrover-Kit v2 | Custom Board | QEMU
75+
validations:
76+
required: true
77+
- type: dropdown
78+
id: power_supply
79+
attributes:
80+
label: Power Supply used.
81+
multiple: false
82+
options:
83+
- USB
84+
- External 5V
85+
- External 3.3V
86+
- Battery
87+
validations:
88+
required: true
89+
- type: textarea
90+
id: expected
91+
attributes:
92+
label: What is the expected behavior?
93+
description: Please provide a clear and concise description of the expected behavior.
94+
placeholder: I expected it to...
95+
validations:
96+
required: true
97+
- type: textarea
98+
id: actual
99+
attributes:
100+
label: What is the actual behavior?
101+
description: Please describe actual behavior.
102+
placeholder: Instead it...
103+
validations:
104+
required: true
105+
- type: textarea
106+
id: steps
107+
attributes:
108+
label: Steps to reproduce.
109+
description: 'How do you trigger this bug? Please walk us through it step by step. Please attach your code here.'
110+
value: |
111+
1. Step
112+
2. Step
113+
3. Step
114+
...
115+
validations:
116+
required: true
117+
- type: textarea
118+
id: debug_logs
119+
attributes:
120+
label: Debug Logs.
121+
description: Debug log goes here, should contain the backtrace, as well as the reset source if it is a crash.
122+
placeholder: Your log goes here.
123+
render: plain
124+
validations:
125+
required: false
126+
- type: textarea
127+
id: diag
128+
attributes:
129+
label: Diagnostic report archive.
130+
description: |
131+
Diagnostic report for ESP-IDF created using [idf.py diag](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-diag.html) or [esp-idf-diag](https://github.com/espressif/esp-idf-diag). The `idf.py diag` command is available beginning with ESP-IDF version 5.5. For older versions, you may want to consider using the `esp-idf-diag` command.
132+
133+
In your project directory, execute the following command:
134+
135+
Using `idf.py diag`
136+
1. idf.py diag
137+
138+
Using `esp-idf-diag`
139+
1. pip install esp-idf-diag
140+
2. esp-idf-diag create
141+
142+
Once the report is generated, the tool will guide you with the next steps.
143+
placeholder: Please attach the diagnostic report zip file here.
144+
validations:
145+
required: false
146+
- type: textarea
147+
id: more-info
148+
attributes:
149+
label: More Information.
150+
description: Do you have any other information from investigating this?
151+
placeholder: ex. I tried on my friend's Windows 10 PC and the command works there.
152+
validations:
153+
required: false

‎.github/ISSUE_TEMPLATE/03_feature_request.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Feature request
2+
description: Suggest an idea for this project.
3+
labels: ['Type: Feature Request']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
* We welcome any ideas or feature requests! It’s helpful if you can explain exactly why the feature would be useful.
9+
* There are usually some outstanding feature requests in the [existing issues list](https://github.com/espressif/esp-idf/labels/Type%3A%20Feature%20Request), feel free to add comments to them.
10+
* If you would like to contribute, please read the [contributions guide](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/contribute/index.html).
11+
- type: textarea
12+
id: problem-related
13+
attributes:
14+
label: Is your feature request related to a problem?
15+
description: Please provide a clear and concise description of what the problem is.
16+
placeholder: ex. I'm always frustrated when ...
17+
- type: textarea
18+
id: solution
19+
attributes:
20+
label: Describe the solution you'd like.
21+
description: Please provide a clear and concise description of what you want to happen.
22+
placeholder: ex. When connecting to an Espressif chip ...
23+
- type: textarea
24+
id: alternatives
25+
attributes:
26+
label: Describe alternatives you've considered.
27+
description: Please provide a clear and concise description of any alternative solutions or features you've considered.
28+
placeholder: ex. Choosing other approach wouldn't work, because ...
29+
- type: textarea
30+
id: context
31+
attributes:
32+
label: Additional context.
33+
description: Please add any other context or screenshots about the feature request here.
34+
placeholder: ex. This would work only when ...

‎.github/ISSUE_TEMPLATE/04_other_issue.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: General issue report
2+
description: File an issue report
3+
body:
4+
- type: checkboxes
5+
id: checklist
6+
attributes:
7+
label: Answers checklist.
8+
description: Before submitting a new issue, please follow the checklist and try to find the answer.
9+
options:
10+
- label: I have read the documentation [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/latest/) and the issue is not addressed there.
11+
required: true
12+
- label: I have updated my IDF branch (master or release) to the latest version and checked that the issue is present there.
13+
required: true
14+
- label: I have searched the issue tracker for a similar issue and not found a similar issue.
15+
required: true
16+
- type: textarea
17+
id: issue
18+
attributes:
19+
label: General issue report
20+
description: Your issue report goes here.
21+
placeholder: ex. How do I run...
22+
validations:
23+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: ESP-IDF Programming Guide
4+
url: https://docs.espressif.com/projects/esp-idf/en/latest/
5+
about: Documentation for configuring and using ESP-IDF
6+
- name: Espressif documentation page
7+
url: https://www.espressif.com/en/support/download/documents
8+
about: Hardware documentation (datasheets, Technical Reference Manual, etc)
9+
- name: Forum
10+
url: https://esp32.com
11+
about: For questions about using ESP-IDF and/or ESP32 series chips. Please submit all questions starting "How do I..." here.
12+
- name: Hardware-related services
13+
url: https://www.espressif.com/en/products/hardware-services
14+
about: Espressif service providing hardware design and certification support

0 commit comments

Comments
 (0)