Skip to content

Commit

Permalink
Merge pull request #114 from ashnwade/main
Browse files Browse the repository at this point in the history
Templates
  • Loading branch information
kris-watts-gravwell authored Apr 23, 2024
2 parents 50c4028 + 68472ba commit 4c24e0e
Show file tree
Hide file tree
Showing 8 changed files with 277 additions and 0 deletions.
57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -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]"
---
<!--
## Instructions
Labels for change type and priority are automatically assigned at the time of creation.
**The default priority is Low. Please change the priority label if this requires more attention.**
Here are suggestions to help you set the correct priority but changes can be made at your discretion.
If this bug is related to:
- lying about data
- core functionality that is broken
please set the priority to Critical.
If this bug is related to:
- Current series objectives
- Next major release objectives
- Impacting or Requested by multiple customers
please set the priority to High.
If this bug does not meet the above criteria but is more important,
please set the priority to Medium.
-->

## 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:**
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/customer_request.md
Original file line number Diff line number Diff line change
@@ -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]"
---
<!--
## Instructions
Labels for change type and priority are automatically assigned at the time of creation.
**The default priority is Low. Please change the priority label if this requires more attention.**
Here are suggestions to help you set the correct priority but changes can be made at your discretion.
If this request is related to:
- Current series objectives
- Next major release objectives
- Impacting or Requested by multiple customers
please set the priority to High.
If this request does not meet the above criteria but is more important,
please set the priority to Medium.
-->

## 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?



29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Documentation
about: Use this template for documentation needs.
labels: documentation, Low
title: "[FEATURE SCOPE]: [TITLE]"
---
<!--
## Instructions
Labels for change type and priority are automatically assigned at the time of creation.
**The default priority is Low. Please change the priority label if this requires more attention.**
Here are suggestions to help you set the correct priority but changes can be made at your discretion.
If this task is related to:
- Current series objectives
- Next major release objectives
please set the priority to High.
If this task does not meet the above criteria but is more important,
please set the priority to Medium.
-->

## What needs to be documented?

## Why is this documentation needed?

## Any other comments?


33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -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]"
---
<!--
## Instructions
Labels for change type and priority are automatically assigned at the time of creation.
**The default priority is Low. Please change the priority label if this requires more attention.**
Here are suggestions to help you set the correct priority but changes can be made at your discretion.
If this request is related to:
- Current series objectives
- Next major release objectives
- Impacting or Requested by multiple customers
please set the priority to High.
If this request does not meet the above criteria but is more important,
please set the priority to Medium.
-->

## 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?



55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/epic.md
Original file line number Diff line number Diff line change
@@ -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]"
---
<!--
## Instructions
Labels for change type and priority are automatically assigned at the time of creation.
**The default priority is Low. Please change the priority label if this requires more attention.**
Here are suggestions to help you set the correct priority but changes can be made at your discretion.
If this epic describes a major release objective,
please set the priority to High.
If this describes a secondary release objective,
please set the priority to Medium.
-->

## 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


33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -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]"
---
<!--
## Instructions
Labels for change type and priority are automatically assigned at the time of creation.
**The default priority is Low. Please change the priority label if this requires more attention.**
Here are suggestions to help you set the correct priority but changes can be made at your discretion.
If this request is related to:
- Current series objectives
- Next major release objectives
- Impacting or Requested by multiple customers
please set the priority to High.
If this request does not meet the above criteria but is more important,
please set the priority to Medium.
-->

## 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?



29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
@@ -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]"
---
<!--
## Instructions
Labels for change type and priority are automatically assigned at the time of creation.
**The default priority is Low. Please change the priority label if this requires more attention.**
Here are suggestions to help you set the correct priority but changes can be made at your discretion.
If this task is related to:
- Current series objectives
- Next major release objectives
please set the priority to High.
If this task does not meet the above criteria but is more important,
please set the priority to Medium.
-->

## What needs to be done?

## Why is this task needed?

## Any other comments?


0 comments on commit 4c24e0e

Please sign in to comment.