Skip to content

Commit b3c203d

Browse files
Pull request/Issue Templates and Readme update (espressif#6577)
* Templates and readme * Templates_and_readme
1 parent 323bbbf commit b3c203d

File tree

3 files changed

+34
-17
lines changed

3 files changed

+34
-17
lines changed

Diff for: .github/ISSUE_TEMPLATE/Issue-report.yml

+5-4
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ body:
3939
label: Version
4040
description: What version of Arduino ESP32 are you running? If possible, consider updating to the latest version.
4141
options:
42-
- latest master
42+
- latest master (checkout manually)
43+
- latest development Release Candidate (RC-X)
4344
- v2.0.2
4445
- v2.0.1
4546
- v2.0.0
@@ -52,7 +53,7 @@ body:
5253
attributes:
5354
label: IDE Name
5455
description: What IDE are you using?
55-
placeholder: eg. Arduino IDE, PlatformIO, IDF component...
56+
placeholder: eg. Arduino IDE, PlatformIO, Sloeber...
5657
validations:
5758
required: true
5859
- type: input
@@ -101,8 +102,8 @@ body:
101102
id: sketch
102103
attributes:
103104
label: Sketch
104-
description: Please provide your sketch/code which was run
105-
placeholder: ex. related part of the code
105+
description: Please provide full minimal sketch/code which can be run to reproduce your issue
106+
placeholder: ex. Related part of the code to replicate the issue
106107
render: cpp
107108
validations:
108109
required: true

Diff for: .github/PULL_REQUEST_TEMPLATE.md

+13-8
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
1-
*By completing this PR sufficiently, you help us to improve the quality of Release Notes*
1+
*By completing this PR sufficiently, you help us to review this Pull Request quicker and also help improve the quality of Release Notes*
22

33
### Checklist
4-
1. [ ] Please provide specific title of the PR describing the change, including the component name (eg. *„Update of Documentation link on Readme.md“*)
5-
2. [ ] Please provide related links (eg. Issue, other Project, submodule PR..)
6-
3. [ ] Please check [Contributing guide](https://docs.espressif.com/projects/arduino-esp32/en/latest/contributing.html)
4+
1. [ ] Please provide specific title of the PR describing the change, including the component name (*eg. „Update of Documentation link on Readme.md“*)
5+
2. [ ] Please provide related links (*eg. Issue which will be closed by this Pull Request*)
6+
3. [ ] Please **update relevant Documentation** if applicable
7+
4. [ ] Please check [Contributing guide](https://docs.espressif.com/projects/arduino-esp32/en/latest/contributing.html)
78

89
*This entire section above can be deleted if all items are checked.*
910

1011
-----------
11-
## Summary
12-
Please describe your proposed PR and what it contains.
12+
## Description of Change
13+
Please describe your proposed Pull Request and it's impact.
1314

14-
## Impact
15-
Please describe impact of your PR and it's function.
15+
## Tests scenarios
16+
Please describe on what Hardware and Software combinations you have tested this Pull Request and how.
17+
18+
(*eg. I have tested my Pull Request on Arduino-esp32 core v2.0.2 with ESP32 and ESP32-S2 Board with this scenario*)
1619

1720
## Related links
1821
Please provide links to related issue, PRs etc.
22+
23+
(*eg. Closes #number of issue*)

Diff for: README.md

+16-5
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,33 @@
22

33
![Build Status](https://github.com/espressif/arduino-esp32/workflows/ESP32%20Arduino%20CI/badge.svg) [![Documentation Status](https://readthedocs.com/projects/espressif-arduino-esp32/badge/?version=latest)](https://docs.espressif.com/projects/arduino-esp32/en/latest/?badge=latest)
44

5-
### Need help or have a question? Join the chat at [![https://gitter.im/espressif/arduino-esp32](https://badges.gitter.im/espressif/arduino-esp32.svg)](https://gitter.im/espressif/arduino-esp32?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
5+
### Need help or have a question? Join the chat at [![https://gitter.im/espressif/arduino-esp32](https://badges.gitter.im/espressif/arduino-esp32.svg)](https://gitter.im/espressif/arduino-esp32?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) or [open a new Discussion](https://github.com/espressif/arduino-esp32/discussions)
66

77
## Contents
88

9-
- [Development Status](#development-status)
10-
- [Decoding Exceptions](#decoding-exceptions)
11-
- [Issue/Bug report template](#issuebug-report-template)
9+
- [Development Status](#development-status)
10+
- [Development Planning](#development-planning)
11+
- [Documentation](#documentation)
12+
- [Supported Chips](#supported-chips)
13+
- [Decoding exceptions](#decoding-exceptions)
14+
- [Issue/Bug report template](#issuebug-report-template)
15+
- [Contributing](#contributing)
1216

1317
### Development Status
1418

1519
Latest Stable Release [![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) [![Release Date](https://img.shields.io/github/release-date/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/) [![Downloads](https://img.shields.io/github/downloads/espressif/arduino-esp32/latest/total.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/latest/)
1620

1721
Latest Development Release [![Release Version](https://img.shields.io/github/release/espressif/arduino-esp32/all.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/) [![Release Date](https://img.shields.io/github/release-date-pre/espressif/arduino-esp32.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/) [![Downloads](https://img.shields.io/github/downloads-pre/espressif/arduino-esp32/latest/total.svg?style=plastic)](https://github.com/espressif/arduino-esp32/releases/)
1822

23+
### Development Planning
24+
25+
Our Development is fully tracked on this public **[Roadmap 🎉](https://github.com/orgs/espressif/projects/3)**
26+
27+
For even more information you can take a look at [Sprint Meeting notes](https://github.com/espressif/arduino-esp32/discussions/categories/sprints-meeting-notes) or join [Monthly Community Meetings 🔔](https://github.com/espressif/arduino-esp32/discussions/categories/monthly-community-meetings)
28+
1929
### Documentation
2030

21-
You can use [Arduino-ESP32 Online Documentation](https://docs.espressif.com/projects/arduino-esp32/en/latest/) to get all information about this project.
31+
You can use the [Arduino-ESP32 Online Documentation](https://docs.espressif.com/projects/arduino-esp32/en/latest/) to get all information about this project.
2232

2333
* [Getting Started](https://docs.espressif.com/projects/arduino-esp32/en/latest/getting_started.html)
2434
* [Installing (Windows, Linux and macOS)](https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html)
@@ -36,6 +46,7 @@ Visit the [supported chips](https://docs.espressif.com/projects/arduino-esp32/en
3646
You can use [EspExceptionDecoder](https://github.com/me-no-dev/EspExceptionDecoder) to get meaningful call trace.
3747

3848
### Issue/Bug report template
49+
3950
Before reporting an issue, make sure you've searched for similar one that was already created. Also make sure to go through all the issues labelled as [Type: For reference](https://github.com/espressif/arduino-esp32/issues?q=is%3Aissue+label%3A%22Type%3A+For+reference%22+).
4051

4152
Finally, if you are sure no one else had the issue, follow the **Issue template** or **Feature request template** while reporting any [new Issue](https://github.com/espressif/arduino-esp32/issues/new/choose).

0 commit comments

Comments
 (0)