From 6f40dc2cca86302416d4f1911ecd71be181e3347 Mon Sep 17 00:00:00 2001 From: Sergio Gasquez Arcos Date: Tue, 10 Sep 2024 12:32:55 +0200 Subject: [PATCH] Add issue templates (#2124) * feat: Add issue templates * feat: Address review comments * feat: Add GH discussion link --- .github/ISSUE_TEMPLATE/bug_report.md | 31 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++++++ .github/ISSUE_TEMPLATE/feature_request.md | 24 ++++++++++++++++++ 3 files changed, 63 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000000..3b424090ed2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,31 @@ +--- +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 + +- Target device: [e.g. ESP32-S3] +- Crate name and version: [e.g. esp-hal 0.20.0] diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..49abd5aecb4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: Ask questions in Matrix channel (Recommended) + url: https://github.com/esp-rs/esp-hal/discussions/new + about: Ask any questions directly in our Matrix channel. + - name: Ask questions in GitHub Discussions + url: https://github.com/esp-rs/esp-hal/discussions/new + about: Post your questions and engage in discussions via GitHub. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000000..47ef65677e0 --- /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 + +