summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2018-12-07 16:51:27 -0800
committerMechMerlin <30334081+mechmerlin@users.noreply.github.com>2018-12-07 16:51:27 -0800
commit2ad2b73d685cf25268fa7d3726f45594edee70c4 (patch)
tree23154d07bc716d1160876d03f9abc54e8efdc438 /.github
parent3e698a54ea22b12512c9e4f676f7d7363c35832f (diff)
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 0000000000..50a32034d6
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/blank.md
@@ -0,0 +1,5 @@
1---
2name: Blank issue
3about: If you're 100% sure that you don't need one of the other issue templates, use this one instead.
4
5---
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000000..a4f90389b0
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,31 @@
1---
2name: Bug report
3about: Create a report to help us improve the QMK Firmware
4---
5<!-- Provide a general summary of the bug in the Title above -->
6
7<!-- This template is entirely option and can be removed, but is here to help both you and us. -->
8<!-- 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. -->
9
10**Describe the bug**
11
12<!-- A clear and concise description of what the bug is. -->
13
14**System Information**
15 - Keyboard:
16 - Revision (if applicable):
17 - Operating System:
18 - avr-gcc version:
19<!-- Run `avr-gcc --version` to find out -->
20 - arm gcc version:
21<!-- Run `arm-none-eabi-gcc --version` to find out -->
22 - QMK Firmware version:
23<!-- You can run `git describe --abbrev=0 --tags` to find this out -->
24 - Any keyboard related software installed?
25 - [ ] Auto Hot Key
26 - [ ] Karabiner
27 - [ ] Other
28
29**Additional context**
30
31<!-- 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 0000000000..c9198adff2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,19 @@
1---
2name: Feature request
3about: Suggest a new feature or changes to existing features
4---
5<!--- Provide a general summary of the changes you want in the Title above -->
6
7<!-- This template is entirely option and can be removed, but is here to help both you and us. -->
8<!-- 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. -->
9
10## Feature Request Type
11
12- [ ] Core Functionality
13- [ ] Add-on hardware support (e.g. audio, RGB, OLED screen, etc.)
14- [ ] Alteration (enhancement/optimization) of existing Feature(s)
15- [ ] New behavior
16
17## Description
18
19<!-- 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 0000000000..5f3e986cc4
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/other_issues.md
@@ -0,0 +1,9 @@
1---
2name: Other issues
3about: Anything else that doesn't fall into the above categories.
4---
5<!--- Provide a general summary of the changes you want in the Title above -->
6
7<!-- 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. -->
8
9<!-- 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 0000000000..05223aa4f6
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,32 @@
1<!--- Provide a general summary of your changes in the Title above -->
2
3<!--- This template is entirely option and can be removed, but is here to help both you and us. -->
4<!--- 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. -->
5
6## Description
7<!--- Describe your changes in detail -->
8
9## Types of changes
10<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
11- [ ] Core
12- [ ] Bugfix
13- [ ] New Feature
14- [ ] Enhancement/Optimization
15- [ ] Keyboard (addition or update)
16- [ ] Keymap/Layout/Userspace (addition or update)
17- [ ] Documentation
18
19
20## Issues Fixed or Closed by this PR
21
22*
23
24## Checklist:
25<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
26<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
27- [ ] My code follows the code style of this project.
28- [ ] My change requires a change to the documentation.
29- [ ] I have updated the documentation accordingly.
30- [ ] I have read the **CONTRIBUTING** document. (https://docs.qmk.fm/#/contributing)
31- [ ] I have added tests to cover my changes.
32- [ ] I have tested the changes and verified that they work and don't break anything (as well as I can manage).