~ruther/qmk_firmware

dc5234746148adf06ef399a50a8ecd1b3f5e999d — Brian Choromanski 2 years ago 88046b3
Added new issue templates for feature requests and bug reports (#18576)

Co-authored-by: Ryan <fauxpark@gmail.com>
4 files changed, 62 insertions(+), 60 deletions(-)

D .github/ISSUE_TEMPLATE/bug_report.md
A .github/ISSUE_TEMPLATE/bug_report.yml
D .github/ISSUE_TEMPLATE/feature_request.md
A .github/ISSUE_TEMPLATE/feature_request.yml
D .github/ISSUE_TEMPLATE/bug_report.md => .github/ISSUE_TEMPLATE/bug_report.md +0 -36
@@ 1,36 0,0 @@
---
name: Bug report
about: Create a report to help us improve QMK Firmware.
title: "[Bug] "
labels: bug, help wanted
assignees: ''

---

<!-- Provide a general summary of the bug in the title above. -->

<!--- This template is entirely optional and can be removed, but is here to help both you and us. -->
<!--- Anything on lines wrapped in comments like these will not show up in the final text. -->

## Describe the Bug

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

## System Information

**Keyboard:** 
**Revision (if applicable):** 
**Operating system:** 
**`qmk doctor` output:** 
```
(Paste output here)
```

**Any keyboard related software installed?** 
 - [ ] AutoHotKey (Windows)
 - [ ] Karabiner (macOS)
 - [ ] Other:

## Additional Context

<!-- Add any other relevant information about the problem here. -->

A .github/ISSUE_TEMPLATE/bug_report.yml => .github/ISSUE_TEMPLATE/bug_report.yml +41 -0
@@ 0,0 1,41 @@
name: Bug report
description: Create a report to help us improve QMK Firmware.
title: "[Bug] "
labels: ["bug", "help wanted"]
body:
  - type: markdown
    attributes:
      value: |
        Provide a general summary of the bug in the title above.
  - type: textarea
    attributes:
      label: Describe the Bug
      description: A clear and concise description of what the bug is.
  - type: input
    attributes:
      label: Keyboard Used
      description: The name of the keyboard from the `make` or `qmk compile`/`qmk flash` commands, eg. `planck/rev6`.
  - type: input
    attributes:
      label: Link to product page (if applicable)
  - type: input
    attributes:
      label: Operating System
  - type: textarea
    attributes:
      label: qmk doctor Output
      description: Output from running the `qmk doctor` command.
      render: text
  - type: checkboxes
    attributes:
      label: Is AutoHotKey / Karabiner installed
      options:
        - label: AutoHotKey (Windows)
        - label: Karabiner (macOS)
  - type: input
    attributes:
      label: Other keyboard-related software installed
  - type: textarea
    attributes:
      label: Additional Context
      description: Add any other relevant information about the problem here.
\ No newline at end of file

D .github/ISSUE_TEMPLATE/feature_request.md => .github/ISSUE_TEMPLATE/feature_request.md +0 -24
@@ 1,24 0,0 @@
---
name: Feature request
about: Suggest a new feature or changes to existing features.
title: "[Feature Request] "
labels: enhancement, help wanted
assignees: ''

---

<!--- Provide a general summary of the changes you want in the title above. -->

<!--- This template is entirely optional and can be removed, but is here to help both you and us. -->
<!--- Anything on lines wrapped in comments like these will not show up in the final text. -->

## Feature Request Type

- [ ] Core functionality
- [ ] Add-on hardware support (eg. audio, RGB, OLED screen, etc.)
- [ ] Alteration (enhancement/optimization) of existing feature(s)
- [ ] New behavior

## Description

<!-- A few sentences describing what it is that you'd like to see in QMK. Additional information (such as links to spec sheets, licensing info, other related issues or PRs, etc) would be helpful. -->

A .github/ISSUE_TEMPLATE/feature_request.yml => .github/ISSUE_TEMPLATE/feature_request.yml +21 -0
@@ 0,0 1,21 @@
name: Feature request
description: Suggest a new feature or changes to existing features.
title: "[Feature Request] "
labels: ["enhancement", "help wanted"]
body:
  - type: markdown
    attributes:
      value: |
        Provide a general summary of the changes you want in the title above.
  - type: checkboxes
    attributes:
      label: Feature Request Type
      options:
        - label: Core functionality
        - label: Add-on hardware support (eg. audio, RGB, OLED screen, etc.)
        - label: Alteration (enhancement/optimization) of existing feature(s)
        - label: New behavior
  - type: textarea
    attributes:
      label: Description
      description: A few sentences describing what it is that you'd like to see in QMK. Additional information (such as links to spec sheets, licensing info, other related issues or PRs, etc) would be helpful.
\ No newline at end of file