diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000000..b1ca40811b7 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +---------------------------------------------------------------------------------------------------------------------------------------------------- +This entire section can be deleted if all items are checked. + +*By completing this PR sufficiently, you help us to improve the quality of Release Notes* + +### Checklist + +1. [ ] Please provide specific title of the PR describing the change, including the component name (eg."Update of Documentation link on Readme.md") +2. [ ] Please provide related links (eg. Issue, other Project, submodule PR..) +---------------------------------------------------------------------------------------------------------------------------------------------------- + +## Summary +Please describe your proposed PR and what it contains. + +## Impact +Please describe impact of your PR and it's function. diff --git a/README.md b/README.md index d4aeb34a21d..80d8f712627 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ You can use [Arduino-ESP32 Online Documentation](https://docs.espressif.com/proj You can use [EspExceptionDecoder](https://github.com/me-no-dev/EspExceptionDecoder) to get meaningful call trace. ### Issue/Bug report template -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 [for reference](https://github.com/espressif/arduino-esp32/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3A%22for%20reference%22%20). +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+). Finally, if you are sure no one else had the issue, follow the [issue template](docs/ISSUE_TEMPLATE.md) while reporting any issue.