summaryrefslogtreecommitdiffstats
path: root/.github
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2018-12-08 01:51:27 +0100
committerMechMerlin <30334081+mechmerlin@users.noreply.github.com>2018-12-08 01:51:27 +0100
commit2ad2b73d685cf25268fa7d3726f45594edee70c4 (patch)
tree23154d07bc716d1160876d03f9abc54e8efdc438 /.github
parent3e698a54ea22b12512c9e4f676f7d7363c35832f (diff)
downloadqmk_firmware-2ad2b73d685cf25268fa7d3726f45594edee70c4.tar.gz
qmk_firmware-2ad2b73d685cf25268fa7d3726f45594edee70c4.tar.xz
Add support for PR and Issue templates to QMK_firmware GitHub (#4494)
* Add support document * Add Bug Report * Add GitHub Pull Request Template * Feature request issue template * Touch up feature request template * Add 'other issues' template * move support doc * Minor tweaks * More minor tweaks * Spleeling fix Co-Authored-By: drashna <drashna@live.com> * CapiTALization fIXes Co-Authored-By: drashna <drashna@live.com> * Use new issue URL Co-Authored-By: drashna <drashna@live.com> * Add blanck issue template * Update the PR template * Formatting and additional changes * Update docs/support.md Co-Authored-By: drashna <drashna@live.com>
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/blank.md5
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md31
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md19
-rw-r--r--.github/ISSUE_TEMPLATE/other_issues.md9
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md32
5 files changed, 96 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/blank.md b/.github/ISSUE_TEMPLATE/blank.md
new file mode 100644
index 000000000..50a32034d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/blank.md
@@ -0,0 +1,5 @@
+---
+name: Blank issue
+about: If you're 100% sure that you don't need one of the other issue templates, use this one instead.
+
+---
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 000000000..a4f90389b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve the QMK Firmware
+---
+<!-- Provide a general summary of the bug in the Title above -->
+
+<!-- This template is entirely option and can be removed, but is here to help both you and us. -->
+<!-- This text and anything on lines wrapped like this one will not show up in the final text. This text is to help us and you. -->
+
+**Describe the bug**
+
+<!-- A clear and concise description of what the bug is. -->
+
+**System Information**
+ - Keyboard:
+ - Revision (if applicable):
+ - Operating System:
+ - avr-gcc version:
+<!-- Run `avr-gcc --version` to find out -->
+ - arm gcc version:
+<!-- Run `arm-none-eabi-gcc --version` to find out -->
+ - QMK Firmware version:
+<!-- You can run `git describe --abbrev=0 --tags` to find this out -->
+ - Any keyboard related software installed?
+ - [ ] Auto Hot Key
+ - [ ] Karabiner
+ - [ ] Other
+
+**Additional context**
+
+<!-- Add any other context about the problem here. -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 000000000..c9198adff
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest a new feature or changes to existing features
+---
+<!--- Provide a general summary of the changes you want in the Title above -->
+
+<!-- This template is entirely option and can be removed, but is here to help both you and us. -->
+<!-- This text and anything on lines wrapped like this one will not show up in the final text. This text is to help us and you. -->
+
+## Feature Request Type
+
+- [ ] Core Functionality
+- [ ] Add-on hardware support (e.g. 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. Additional information (such as links to spec sheets, licensing info, other related issues or PR's, etc) would be helpful. -->
diff --git a/.github/ISSUE_TEMPLATE/other_issues.md b/.github/ISSUE_TEMPLATE/other_issues.md
new file mode 100644
index 000000000..5f3e986cc
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/other_issues.md
@@ -0,0 +1,9 @@
+---
+name: Other issues
+about: Anything else that doesn't fall into the above categories.
+---
+<!--- Provide a general summary of the changes you want in the Title above -->
+
+<!-- This text and anything on lines wrapped like this one will not show up in the final text. This text is to help us and you. -->
+
+<!-- Please check https://docs.qmk.fm/#/support for additional resources first. If that doesn't answer your question, check the bug report option, as that may be more appropriate. -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 000000000..05223aa4f
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,32 @@
+<!--- Provide a general summary of your changes in the Title above -->
+
+<!--- This template is entirely option and can be removed, but is here to help both you and us. -->
+<!--- This text and anything on lines wrapped like this one will not show up in the final text. This text is to help us and you. -->
+
+## Description
+<!--- Describe your changes in detail -->
+
+## Types of changes
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Core
+- [ ] Bugfix
+- [ ] New Feature
+- [ ] Enhancement/Optimization
+- [ ] Keyboard (addition or update)
+- [ ] Keymap/Layout/Userspace (addition or update)
+- [ ] Documentation
+
+
+## Issues Fixed or Closed by this PR
+
+*
+
+## Checklist:
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] My code follows the code style of this project.
+- [ ] My change requires a change to the documentation.
+- [ ] I have updated the documentation accordingly.
+- [ ] I have read the **CONTRIBUTING** document. (https://docs.qmk.fm/#/contributing)
+- [ ] I have added tests to cover my changes.
+- [ ] I have tested the changes and verified that they work and don't break anything (as well as I can manage).