From 68472baf2e2d7833c2af6c20d2c8ce56f66b9a64 Mon Sep 17 00:00:00 2001 From: ashnwade Date: Tue, 23 Apr 2024 15:22:52 -0400 Subject: [PATCH] templates --- .github/ISSUE_TEMPLATE/bug.md | 57 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++ .github/ISSUE_TEMPLATE/customer_request.md | 33 +++++++++++++ .github/ISSUE_TEMPLATE/documentation.md | 29 +++++++++++ .github/ISSUE_TEMPLATE/enhancement.md | 33 +++++++++++++ .github/ISSUE_TEMPLATE/epic.md | 55 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature.md | 33 +++++++++++++ .github/ISSUE_TEMPLATE/task.md | 29 +++++++++++ 8 files changed, 277 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/customer_request.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/enhancement.md create mode 100644 .github/ISSUE_TEMPLATE/epic.md create mode 100644 .github/ISSUE_TEMPLATE/feature.md create mode 100644 .github/ISSUE_TEMPLATE/task.md diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000..5ae7c01 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,57 @@ +--- +name: Bug Report +about: Use this template for reporting a bug. A bug is an unexpected problem or unintended behavoir that breaks functionality. However, UX improvements should be documented as an enhancement. +labels: bug, Low +title: "[FEATURE SCOPE]: [BUG TITLE]" +--- + + +## What are the steps to reproduce this issue? + +1. +2. +3. + +## What happens? + + + +## What were you expecting to happen? + + + +## Any logs, error output, etc? + + + +## Any other comments? + + + +## What versions of software are you using? + +**Browser:** + +**Current version:** +**Server build:** +**Client build:** diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..c8d01c5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +# disable blank issue creation +blank_issues_enabled: false + +# direct users to appropriate channels for discussion +contact_links: + - name: Gravwell Community Support + url: https://discord.com/invite/gravwell + about: Please ask and answer questions here. diff --git a/.github/ISSUE_TEMPLATE/customer_request.md b/.github/ISSUE_TEMPLATE/customer_request.md new file mode 100644 index 0000000..7d87732 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/customer_request.md @@ -0,0 +1,33 @@ +--- +name: Customer Feature Request +about: Use this template for documenting a new feature requested by a customer. +labels: feature, customer request, Low +title: "[FEATURE SCOPE]: [TITLE]" +--- + + +## What is the feature to be added? + +## Why should we add this feature? (Business justification? What problem is the feature trying to solve?) + +## How does this feature address the above problem? + +## Any other comments? + + + diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..754f91e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,29 @@ +--- +name: Documentation +about: Use this template for documentation needs. +labels: documentation, Low +title: "[FEATURE SCOPE]: [TITLE]" +--- + + +## What needs to be documented? + +## Why is this documentation needed? + +## Any other comments? + + diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md new file mode 100644 index 0000000..e9b4693 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -0,0 +1,33 @@ +--- +name: Enhancement +about: Use this template for requesting an enhancement. An enhancement is an improvement or extension of an existing feature. Enhancements should be used to document UX improvements. +labels: enhancement, Low +title: "[FEATURE SCOPE]: [TITLE]" +--- + + +## What is the enhancement to be made? + + +## Why should we make this change? (Business justification? What problem is the feature trying to solve?) + + +## Any other comments? + + + diff --git a/.github/ISSUE_TEMPLATE/epic.md b/.github/ISSUE_TEMPLATE/epic.md new file mode 100644 index 0000000..270e9c3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/epic.md @@ -0,0 +1,55 @@ +--- +name: Epic +about: Use this template for an epic. An epic is used to document a task list that must be accomplished in order to complete a project or a larger goal +labels: epic, Low +title: "[FEATURE SCOPE]: [TITLE]" +--- + + +## Overview + +### Background + +### Technical Requirements + +## User Stories + +Please provide user stories to help define the desired behaviors. Gherkin syntax is preferred so that we can use the stories to write cypress tests for new features. + +## Milestones + +Please provide a list of major milestones and to the extent possible, define a checklist of items to be completed for each milestone. It is expected that we will add to this list as the work progresses. + +### Proof Concept + +#### Frontend +- [ ] Task 1 +- [ ] Task 2 + +#### Backend +- [ ] Task A +- [ ] Task B + +### Milestone 2 + +List + +### Milestone 3 + +List + +## Other Notes + + diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md new file mode 100644 index 0000000..8667e14 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -0,0 +1,33 @@ +--- +name: Feature Request +about: Use this template for requesting a new feature. This template should be used to request a new feature or functionality that does not currently exist in the application. +labels: feature, Low +title: "[FEATURE SCOPE]: [TITLE]" +--- + + +## What is the feature to be added? + +## Why should we add this feature? (Business justification? What problem is the feature trying to solve?) + +## How does this feature address the above problem? + +## Any other comments? + + + diff --git a/.github/ISSUE_TEMPLATE/task.md b/.github/ISSUE_TEMPLATE/task.md new file mode 100644 index 0000000..0501dfd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.md @@ -0,0 +1,29 @@ +--- +name: Task +about: Use this template for a task. A task should be used for refactoring, automated testing, configuration changes, or other supporting tasks that are not directly related to product development. +labels: task, Low +title: "[FEATURE SCOPE]: [TITLE]" +--- + + +## What needs to be done? + +## Why is this task needed? + +## Any other comments? + +