🎉 new issues templates (#488)

This commit is contained in:
Zineb El Bachiri 2023-07-03 15:56:38 +02:00 committed by GitHub
parent d840173992
commit 7eccc5bb9d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 74 additions and 0 deletions

40
.github/ISSUE_TEMPLATE/EPIC_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,40 @@
---
about: Use this template for epics.
title: "[Epic]"
labels: epic
---
# The why
Why do we need this functionality?
Whats the value? For whom?
# The what
## What are we developing?
Whats 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?
## Whats out of scope for this feature?
## Should this feature be feature flagged?
# The how
## How are we going to code this feature?
Whats 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?

View File

@ -0,0 +1,28 @@
---
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 ...

6
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,6 @@
blank_issues_enabled: false
contact_links:
- name: Quivr Community Discord
url: https://discord.gg/HUpRgp2HG8
about: Please ask and answer questions here.
```