Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Templates #125

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: 🐛 Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Expected behavior**
A clear and concise description of what you expected to happen.

**Actual Behavior**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Screenshots showcasing the issue**
If applicable, add screenshots to help explain your problem.

**Additional context**
Add any other context relevant to the problem.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: 🚀 Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Describe the Feature**
A clear and concise description of the feature you are proposing

**Need of this Feature**
Why do you think this project requires such a feature? What problem does it solve?

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
36 changes: 36 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
**IMPORTANT: Please do not create a Pull Request without creating an issue first.**

Please provide enough information so that others can review your pull request:

**Description**

Describe your code changes in detail for the Reviewers. Explain the technical solution you have provided and how it solves the issue.

**Testing Methods**

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

- [ ] Test A
- [ ] Test B

**Test Configuration**:

- Firmware version:
- Hardware:
- Toolchain:
- SDK:

**Screenshots**

Attach any screenshots, if available, displaying the mentioned changes for the verification and reviewing purpose.

**Type of change**

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

**Closing Issues**

Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such).