diff options
| author | hathach <[email protected]> | 2020-04-19 14:02:39 +0700 |
|---|---|---|
| committer | hathach <[email protected]> | 2020-04-19 14:02:39 +0700 |
| commit | 7f92e255cf27541f3d673fbd80aededd0f462d00 (patch) | |
| tree | 6a6457d3321f98c337cc874e27c2a299e39f10a0 /.github | |
| parent | c0047e376f108a08364c631ef77156143b8fe7c5 (diff) | |
added TODO item for changelog
- rewrite changelog it better later on
- simplify the issue template
Diffstat (limited to '.github')
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 27 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.md | 13 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/porting.md | 8 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/question.md | 2 |
4 files changed, 13 insertions, 37 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 97903dc36..c4d2757d2 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,26 +7,17 @@ assignees: '' --- -**Describe the bug** -A clear and concise description of what the bug is. +**Set up (mandatory):** +Provide details of your setup help us to reproduce the issue as quick as possible + - **PC OS** : Ubuntu 18.04 / Windows 10/ macOS 10.15 + - **Board** : Feather nRF52840 Express + - **Firmware**: examples/device/cdc_msc -**Set up (please complete the following information):** - - OS: [e.g. Ubuntu 18.04] - - Board: [e.g pca10056] - - Firmware Code: [e.g examples/device/cdc_msc_hid] +**Bug Description** +Describe what the bug is. -**To Reproduce** +**Reproduce** Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Additional context** -Add any other context about the problem here. +3. See error diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index e74cb57fa..cb211eeb4 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,14 +7,5 @@ assignees: '' --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**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. +**Feature Description** +Describe your feature diff --git a/.github/ISSUE_TEMPLATE/porting.md b/.github/ISSUE_TEMPLATE/porting.md index fc2b2b8d8..9e4097ac2 100644 --- a/.github/ISSUE_TEMPLATE/porting.md +++ b/.github/ISSUE_TEMPLATE/porting.md @@ -7,11 +7,5 @@ assignees: '' --- -**Porting layer** - - [ ] Device Controller Driver (DCD) - - [ ] Host Controller Driver (HCD) - - [ ] Board Supported Package (BSP) - - [ ] OS Abstraction Layer (OSAL) - **Description** -A clear and concise description of what you want to happen. +Describe which API you want to port (DCD/HCD/OSAL/BSP). It is also helpful to go through [porting.md](docs/porting.md) first if you haven't yet. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 1de8fb9a4..3a9fd205c 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -7,4 +7,4 @@ assignees: '' --- -**Here is my question** +**Question Description** |
