diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a03a7e2cbc5..d6116fa91f7 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,18 +1,20 @@ -## Thank you! +## Thank you for your contribution! -Thank you for your contribution. -Please make sure that your submission includes the following: +We appreciate the time and effort you've put into this pull request. +To help us review it efficiently, please ensure you've gone through the following checklist: -### Must -- [ ] The code compiles without `errors` or `warnings`. -- [ ] All examples work. -- [ ] `cargo fmt` was run. -- [ ] Your changes were added to the `CHANGELOG.md` in the proper section. -- [ ] You updated existing examples or added examples (if applicable). -- [ ] Added examples are checked in CI +### Submission Checklist 📝 +- [ ] Examples related to your contribution work as expected +- [ ] My changes were added to the [`CHANGELOG.md`](https://github.com/esp-rs/esp-hal/blob/main/esp-hal/CHANGELOG.md) in the proper section. +- [ ] I have updated existing examples or added examples (if applicable). +Extra: +- [ ] I have read the [CONTRIBUTING.md guide](https://github.com/esp-rs/esp-hal/blob/main/CONTRIBUTING.md) and followed its instructions. -### Nice to have +### Pull Request Details 📖 -- [ ] You add a description of your work to this PR. -- [ ] You added proper docs for your newly added features and code. +#### Testing +Describe how you tested your changes. + +#### Description +Please provide a clear and concise description of your changes, including the motivation behind these changes. The context is crucial for the reviewers.