Skip to content

Commit

Permalink
Add issue templates (#2124)
Browse files Browse the repository at this point in the history
* feat: Add issue templates

* feat: Address review comments

* feat: Add GH discussion link
  • Loading branch information
SergioGasquez authored Sep 10, 2024
1 parent e1c27f1 commit 6f40dc2
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ["bug", "status:needs-attention"]
assignees: ''

---

## Bug description

<!-- A clear and concise description of what the bug is. -->

## To Reproduce

<!-- Steps to reproduce the behavior. -->
1. ...
2. ...

<!-- Please share the minimal repro of the issue where the bug can be reproduced. -->

<!-- Make sure you are able to reproduce the bug in the `main` branch, too. -->

## Expected behavior

<!-- A clear and concise description of what you expected to happen. Attach screenshots if needed. -->

## Environment

- Target device: [e.g. ESP32-S3] <!-- Use `espflash board-info` to get the target device iformation. -->
- Crate name and version: [e.g. esp-hal 0.20.0]
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ["enhancement", "status:needs-attention"]
assignees: ''

---

## Motivations

<!-- If your feature request is related to a problem, please describe it. -->

## Solution

<!-- Describe the solution you'd like. -->

## Alternatives

<!-- Describe any alternative solutions or features you've considered. -->

## Additional context

<!-- Add any other context or screenshots about the feature request here. -->

0 comments on commit 6f40dc2

Please sign in to comment.