From 17c0d15a8bcb7355d046ede0a4c75a92dd8a243a Mon Sep 17 00:00:00 2001 From: "Ben V. Brown" Date: Mon, 12 Mar 2018 17:04:11 +1100 Subject: [PATCH] Add issue and pull request templates --- ISSUE_TEMPLATE.md | 46 ++++++++++++++++++++++++++++++++++++++++ PULL_REQUEST_TEMPLATE.md | 29 +++++++++++++++++++++++++ 2 files changed, 75 insertions(+) create mode 100644 ISSUE_TEMPLATE.md create mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..c9b60a11 --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,46 @@ +Please edit this template and fill out all the information you can (where relevant). Failure to provide essential information can delay the response you receive. + + +* **I'm submitting a ...** + - [ ] Bug report + - [ ] Feature request + - [ ] Translation + + +* **Do you want to request a *feature* or report a *bug*?** + + + +* **What is the current behavior?** + + +* **What is the expected behavior?** + + +* **If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem** + +***Steps to reproduce:*** + +1. +2. +3. + +***Video of problem if hard to reproduce*** + +* **What is the motivation / use case for changing the behavior?** + + + +* **What are you running:** + +On the idle screen, you can hold the settings button and it will show you the firmware version. + + - Firmware Version: 2.x + - PCB Version: (1/2) + - Power Supply (Voltage and Current Rating) : + + +* **Other information** + +If submitting graphics to go on the iron, please use BMP or PNG files over JPG. + diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..db95d26d --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,29 @@ + +Please try and fill out this template where possible, not all fields are required and can be removed. + +* **Please check if the PR fulfills these requirements** +- [ ] The commit message make sense +- [ ] The changes have been tested locally +- [ ] New features have been documented in the Wiki +- [ ] I'm willing to maintain this in the future (Totally Optional) + + +* **What kind of change does this PR introduce?** +(Bug fix, feature, docs update, ...) + + + +* **What is the current behavior?** +(You can also link to an open issue here) + + + +* **What is the new behavior (if this is a feature change)?** + + + +* **Does this PR introduce a breaking change?** +(What changes might users need to make in their application due to this PR?) + + +* **Other information**: