diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..cf7ec53e80 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: ["bug", "status:needs-attention"] +assignees: '' + +--- + +## Bug description + + + +## To Reproduce + + +1. ... +2. ... + + + + + +## Expected behavior + + + +## Environment + +- Crate (`esp-idf-hal`) version: [e.g. 0.44.1; type master if you use the crate from the GIT master branch] +- ESP-IDF branch or tag: [e.g. release/v5.2, v5.2.1, etc.] +- Target device: [e.g. ESP32-S3] diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..897d5178b8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Ask questions in Matrix channel + url: https://matrix.to/#/#esp-rs:matrix.org + about: Ask any questions directly in our Matrix channel. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..47ef65677e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,24 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: ["enhancement", "status:needs-attention"] +assignees: '' + +--- + +## Motivations + + + +## Solution + + + +## Alternatives + + + +## Additional context + + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..4bd683f5bf --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,18 @@ +## Thank you for your contribution! + +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: + +### Submission Checklist 📝 +- [ ] I have updated existing examples or added new ones (if applicable). +- [ ] I have used `cargo fmt` command to ensure that all changed code is formatted correctly. +- [ ] I have used `cargo clippy` command to ensure that all changed code passes latest Clippy nightly lints. +- [ ] My changes were added to the [`CHANGELOG.md`](https://github.com/esp-rs/esp-idf-sys/blob/main/esp-idf-sys/CHANGELOG.md) in the **_proper_** section. + +### Pull Request Details 📖 + +#### Description +Please provide a clear and concise description of your changes, including the motivation behind these changes. The context is crucial for the reviewers. + +#### Testing +Describe how you tested your changes. \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index fb9a95b3c3..72d48e80dd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [Unreleased] + +### Deprecated + +### Breaking + +### Added + +### Fixed + ## [0.44.1] - 2024-07-09 ### Fixed * The crate now does build with ESP-IDF V4.4.x + esp32c2/esp32c6/esp32h2, yet these MCUs should only be used with ESP-IDF V5+