From 19c9c0b41a5617386c470a9fd61937a0b30780b3 Mon Sep 17 00:00:00 2001 From: Ryan Date: Sat, 4 May 2019 17:20:36 +0100 Subject: [PATCH] Add Github template files --- .github/ISSUE_TEMPLATE/bug_report.md | 31 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 17 +++++++++++++ .github/pull_request_template.md | 23 +++++++++++++++++ 3 files changed, 71 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..5a546bd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,31 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + +**Version** + +- Specify the project release version you're experiencing a bug with. + +**Reproduction link** + +- Please add the reproduction link where the bug is found. + +**Steps to reproduce** + +1. ... +2. ... +3. ... + +**What is expected?** + +- What is the expected behaviour? + +**What is actually happening?** + +- What is happening instead? + +**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 0000000..066b2d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for this project + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..e245a52 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,23 @@ +## Highlights + +- List out a summary of changes here + +### :rocket: Added + +- List out the Jira card followed by the title of what's been added. + +### :rotating_light: Fixed + +- List out the Jira card followed by the title of what's been fixed. + +### :wrench: Updated + +- List out the Jira card followed by the title of what's been updated or changed. + +### :no_entry: Removed + +- List out the Jira card followed by the title of what's been removed. + +---- + +:warning: Is this a new major or minor release? These versions could contain breaking-changes. Please ensure to test this pull request.