From fab9c91b33bc857029c0d002fdb4ef1f6f071683 Mon Sep 17 00:00:00 2001 From: Pharap <2933055+Pharap@users.noreply.github.com> Date: Thu, 25 Mar 2021 07:12:21 +0000 Subject: [PATCH] Create issue templates (#79) --- .github/ISSUE_TEMPLATE/bug-report.md | 42 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 27 +++++++++++++++ 2 files changed, 69 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 0000000..6756439 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,42 @@ +--- +name: Bug Report +about: The standard template for a bug report +title: '' +labels: '' +assignees: Pharap + +--- + +_Delete and replace any italicised text and instructions before submitting._ +_You may also delete a section heading when instructed to delete a section._ + +**Brief Description** + +_Provide a brief summary of the problem._ + +**Observed Behaviour** + +_Provide a description of what behaviour you observed._ + +**Expected Behaviour** + +_Provide a description of what behaviour you expected._ + +**Compiler Error** + +_If the bug results in a compile time error, provide the full text of any relevant compiler errors as reported by the compiler. Otherwise delete this section._ + +**Source Code** + +_Provide some source code demonstrating the issue, preferably as a concise stand-alone `.ino` file._ + +_Alternatively if the issue was exhibited by a complex program and the issue cannot be isolated, provide a link to a repository hosting said program. This link should ideally link to a precise commit snapshot rather than to a branch or repo because a commit snapshot won't change if more commits are added and won't break if branches are deleted._ + +**Extra Information** + +_Fill in the relevant information fields. Please be as precise as possible._ + +* Target Board: _Arduino Uno R3_ +* Compiler Version: _avr-g++ 5.4.0_ +* Arduino IDE Version: _1.8.13_ +* OS: _Windows 10_ diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 0000000..3013ce8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,27 @@ +--- +name: Feature Request +about: The standard template for a feature request +title: '' +labels: '' +assignees: Pharap + +--- + +_Delete and replace any italicised text and instructions before submitting._ +_You may also delete a section heading when instructed to delete a section._ + +**Proposed Feature** + +_Provide an explanation of your proposed feature._ + +**Use Case** + +_Provide an explanation of one or more situations in which your proposed feature would be beneficial._ + +**Problem** + +_If your proposed feature solves one or more specific problems, provide an explanation of the problem or problems than it solves. Otherwise, delete this section._ + +**Justification** + +_If your proposed feature entails a specific implementation of a solution to a problem, please provide an explanation of why your proposed solution is the most suitable solution. Otherwise, delete this section._