mirror of
https://github.com/StanGirard/quivr.git
synced 2024-08-17 09:00:33 +03:00
Update issue templates
This commit is contained in:
parent
7eccc5bb9d
commit
1133c1f0cf
40
.github/ISSUE_TEMPLATE/EPIC_TEMPLATE.md
vendored
40
.github/ISSUE_TEMPLATE/EPIC_TEMPLATE.md
vendored
@ -1,40 +0,0 @@
|
||||
---
|
||||
about: Use this template for epics.
|
||||
title: "[Epic]"
|
||||
labels: epic
|
||||
---
|
||||
|
||||
# The why
|
||||
|
||||
Why do we need this functionality?
|
||||
What’s the value? For whom?
|
||||
|
||||
# The what
|
||||
|
||||
## What are we developing?
|
||||
|
||||
What’s the expected behaviour? How should it look like?
|
||||
|
||||
## What are the validation criteria to validate this feature?
|
||||
|
||||
What are you going to test to validate this feature? What are the edge cases? How should the feature behave in case of error ? How should the feature behave in case of missing data ? Are there other specific behaviours that should be clarified?
|
||||
|
||||
## What’s out of scope for this feature?
|
||||
|
||||
## Should this feature be feature flagged?
|
||||
|
||||
# The how
|
||||
|
||||
## How are we going to code this feature?
|
||||
|
||||
What’s the technical strategy to deliver? What are the impacts on the architecture diagram? What could be the unexpected consequences of the feature on other parts of the code? Could there be other technical edge cases?
|
||||
|
||||
## Are there any technical decisions made that should be shared?
|
||||
|
||||
Did you make any ADR for this feature that should be shared and validated?
|
||||
|
||||
## What is preventing us from delivering this feature?
|
||||
|
||||
Are there functional dependencies? Are there métier dependencies? Are there internal teams that need to be consulted/need to validate
|
||||
|
||||
## What can the feature potentially break?
|
28
.github/ISSUE_TEMPLATE/USER_STORY_TEMPLATE.md
vendored
28
.github/ISSUE_TEMPLATE/USER_STORY_TEMPLATE.md
vendored
@ -1,28 +0,0 @@
|
||||
---
|
||||
about: Use this template for user stories.
|
||||
title: "[Epic]: User story"
|
||||
labels: user story
|
||||
---
|
||||
|
||||
# Epic
|
||||
|
||||
Include the issue that represents the epic.
|
||||
|
||||
# Functional
|
||||
|
||||
Please explain in detail the functionality.
|
||||
Please also include relevant motivation and context.
|
||||
|
||||
## Schema
|
||||
|
||||
### Tech
|
||||
|
||||
- [] To-do
|
||||
|
||||
### Tests
|
||||
|
||||
- [] it ...
|
||||
|
||||
### Validation Checks
|
||||
|
||||
- [] it ...
|
10
.github/ISSUE_TEMPLATE/this-is-an-example.md
vendored
Normal file
10
.github/ISSUE_TEMPLATE/this-is-an-example.md
vendored
Normal file
@ -0,0 +1,10 @@
|
||||
---
|
||||
name: This is an example
|
||||
about: Example
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user