mirror of
https://github.com/QuivrHQ/quivr.git
synced 2024-12-15 17:43:03 +03:00
chore(github): fixed
This commit is contained in:
Stan Girard
parent
8fb8004548
commit
c1b47bee32
60
.github/ISSUE_TEMPLATE/EPIC_TEMPLATE.yml
vendored
60
.github/ISSUE_TEMPLATE/EPIC_TEMPLATE.yml
vendored
@ -4,94 +4,94 @@ title: "[Epic]: "
|
||||
labels: ["epic"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
attributes:
|
||||
value: |
|
||||
**The Why**
|
||||
|
||||
Explain the reasons for this epic.
|
||||
|
||||
- type: textarea
|
||||
id: why-value
|
||||
attributes:
|
||||
id: why-value
|
||||
attributes:
|
||||
label: Why do we need this functionality?
|
||||
description: What's the value? For whom?
|
||||
placeholder: Detail the reasons here...
|
||||
validations:
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: markdown
|
||||
attributes:
|
||||
attributes:
|
||||
value: |
|
||||
**The What**
|
||||
**The What**
|
||||
|
||||
- type: textarea
|
||||
id: developing
|
||||
attributes:
|
||||
id: developing
|
||||
attributes:
|
||||
label: What are we developing?
|
||||
description: What’s the expected behaviour? How should it look like?
|
||||
placeholder: Describe the functionality or feature here...
|
||||
validations:
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: validation-criteria
|
||||
attributes:
|
||||
id: validation-criteria
|
||||
attributes:
|
||||
label: What are the validation criteria to validate this feature?
|
||||
description: Testing criteria, edge cases, error behavior, etc.
|
||||
placeholder: Detail the validation criteria here...
|
||||
validations:
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: out-of-scope
|
||||
attributes:
|
||||
id: out-of-scope
|
||||
attributes:
|
||||
label: What's out of scope for this feature?
|
||||
placeholder: Detail what's not covered by this epic...
|
||||
validations:
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: feature-flagged
|
||||
attributes:
|
||||
id: feature-flagged
|
||||
attributes:
|
||||
label: Should this feature be feature flagged?
|
||||
options:
|
||||
- label: Yes
|
||||
- label: No
|
||||
|
||||
- type: markdown
|
||||
attributes:
|
||||
attributes:
|
||||
value: |
|
||||
**The How**
|
||||
|
||||
- type: textarea
|
||||
id: code-strategy
|
||||
attributes:
|
||||
id: code-strategy
|
||||
attributes:
|
||||
label: How are we going to code this feature?
|
||||
description: Technical strategy, impacts, consequences, etc.
|
||||
placeholder: Describe the technical approach here...
|
||||
validations:
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: technical-decisions
|
||||
attributes:
|
||||
id: technical-decisions
|
||||
attributes:
|
||||
label: Are there any technical decisions made that should be shared?
|
||||
placeholder: Detail the decisions here...
|
||||
validations:
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: blockers
|
||||
attributes:
|
||||
id: blockers
|
||||
attributes:
|
||||
label: What is preventing us from delivering this feature?
|
||||
placeholder: Detail any dependencies, issues, or blockers here...
|
||||
validations:
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: potential-breaks
|
||||
attributes:
|
||||
id: potential-breaks
|
||||
attributes:
|
||||
label: What can the feature potentially break?
|
||||
placeholder: Detail any potential side effects or issues here...
|
||||
validations:
|
||||
validations:
|
||||
required: true
|
||||
|
||||
46
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml
vendored
46
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml
vendored
@ -4,29 +4,29 @@ title: "[Feature]: "
|
||||
labels: ["enhancement"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for making Quivr better!
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for making Quivr better!
|
||||
- type: textarea
|
||||
id: the-feature
|
||||
attributes:
|
||||
label: The Feature
|
||||
description: A clear and concise description of the feature proposal
|
||||
placeholder: Tell us what you want!
|
||||
validations:
|
||||
required: true
|
||||
id: the-feature
|
||||
attributes:
|
||||
label: The Feature
|
||||
description: A clear and concise description of the feature proposal
|
||||
placeholder: Tell us what you want!
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: motivation
|
||||
attributes:
|
||||
label: Motivation, pitch
|
||||
description: Please outline the motivation for the proposal. Is your feature request related to a specific problem? e.g., "I'm working on X and would like Y to be possible". If this is related to another GitHub issue, please link here too.
|
||||
validations:
|
||||
required: true
|
||||
id: motivation
|
||||
attributes:
|
||||
label: Motivation, pitch
|
||||
description: Please outline the motivation for the proposal. Is your feature request related to a specific problem? e.g., "I'm working on X and would like Y to be possible". If this is related to another GitHub issue, please link here too.
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: contact
|
||||
attributes:
|
||||
label: Twitter / LinkedIn details
|
||||
description: We announce new features on Twitter + LinkedIn. When this is announced, and you'd like a mention, we'll gladly shout you out!
|
||||
placeholder: ex. @_StanGirard/ <https://www.linkedin.com/in/stanislas-girard/>
|
||||
validations:
|
||||
required: false
|
||||
id: contact
|
||||
attributes:
|
||||
label: Twitter / LinkedIn details
|
||||
description: We announce new features on Twitter + LinkedIn. When this is announced, and you'd like a mention, we'll gladly shout you out!
|
||||
placeholder: ex. @_StanGirard/ <https://www.linkedin.com/in/stanislas-girard/>
|
||||
validations:
|
||||
required: false
|
||||
|
||||
54
.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.yml
vendored
54
.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.yml
vendored
@ -3,30 +3,30 @@ description: File a bug report
|
||||
title: "[Bug]: "
|
||||
labels: ["bug"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this bug report!
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: Also tell us, what did you expect to happen?
|
||||
placeholder: Tell us what you see!
|
||||
value: "A bug happened!"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Relevant log output
|
||||
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
|
||||
render: shell
|
||||
- type: input
|
||||
id: contact
|
||||
attributes:
|
||||
label: Twitter / LinkedIn details
|
||||
description: We announce new features on Twitter + LinkedIn. If this issue leads to an announcement, and you'd like a mention, we'll gladly shout you out!
|
||||
placeholder: ex. @_StanGirard / <<https://www.linkedin.com/in/stanislas-girard/>>
|
||||
validations:
|
||||
required: false
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this bug report!
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: Also tell us, what did you expect to happen?
|
||||
placeholder: Tell us what you see!
|
||||
value: "A bug happened!"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Relevant log output
|
||||
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
|
||||
render: shell
|
||||
- type: input
|
||||
id: contact
|
||||
attributes:
|
||||
label: Twitter / LinkedIn details
|
||||
description: We announce new features on Twitter + LinkedIn. If this issue leads to an announcement, and you'd like a mention, we'll gladly shout you out!
|
||||
placeholder: ex. @_StanGirard / <<https://www.linkedin.com/in/stanislas-girard/>>
|
||||
validations:
|
||||
required: false
|
||||
|
||||
108
.github/ISSUE_TEMPLATE/USER_STORY_TEMPLATE.yml
vendored
108
.github/ISSUE_TEMPLATE/USER_STORY_TEMPLATE.yml
vendored
@ -4,78 +4,78 @@ title: "[Epic]: User story"
|
||||
labels: ["user story"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
**Epic**
|
||||
attributes:
|
||||
value: |
|
||||
**Epic**
|
||||
|
||||
Include the issue that represents the epic.
|
||||
Include the issue that represents the epic.
|
||||
|
||||
- type: input
|
||||
id: epic-link
|
||||
attributes:
|
||||
label: Link to the Epic
|
||||
placeholder: Paste the link to the related epic here...
|
||||
validations:
|
||||
required: true
|
||||
id: epic-link
|
||||
attributes:
|
||||
label: Link to the Epic
|
||||
placeholder: Paste the link to the related epic here...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
**Functional**
|
||||
attributes:
|
||||
value: |
|
||||
**Functional**
|
||||
|
||||
Detail the functionality and provide context and motivation.
|
||||
Detail the functionality and provide context and motivation.
|
||||
|
||||
- type: textarea
|
||||
id: functionality-detail
|
||||
attributes:
|
||||
label: Explain the Functionality
|
||||
placeholder: Detail the user story functionality here...
|
||||
validations:
|
||||
required: true
|
||||
id: functionality-detail
|
||||
attributes:
|
||||
label: Explain the Functionality
|
||||
placeholder: Detail the user story functionality here...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
**Schema**
|
||||
attributes:
|
||||
value: |
|
||||
**Schema**
|
||||
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
### Tech
|
||||
attributes:
|
||||
value: |
|
||||
### Tech
|
||||
|
||||
- type: checkboxes
|
||||
id: tech-todo
|
||||
attributes:
|
||||
label: Tech To-dos
|
||||
options:
|
||||
- label: To-do Item 1
|
||||
- label: To-do Item 2
|
||||
# Add more to-dos as needed
|
||||
id: tech-todo
|
||||
attributes:
|
||||
label: Tech To-dos
|
||||
options:
|
||||
- label: To-do Item 1
|
||||
- label: To-do Item 2
|
||||
# Add more to-dos as needed
|
||||
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
### Tests
|
||||
attributes:
|
||||
value: |
|
||||
### Tests
|
||||
|
||||
- type: checkboxes
|
||||
id: tests
|
||||
attributes:
|
||||
label: Test Cases
|
||||
options:
|
||||
- label: it should ...
|
||||
- label: it can ...
|
||||
# Add more test cases as needed
|
||||
|
||||
id: tests
|
||||
attributes:
|
||||
label: Test Cases
|
||||
options:
|
||||
- label: it should ...
|
||||
- label: it can ...
|
||||
# Add more test cases as needed
|
||||
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
### Validation Checks
|
||||
attributes:
|
||||
value: |
|
||||
### Validation Checks
|
||||
|
||||
- type: checkboxes
|
||||
id: validation-checks
|
||||
attributes:
|
||||
label: Validation Checks
|
||||
options:
|
||||
- label: it should validate ...
|
||||
- label: it shouldn't allow ...
|
||||
# Add more validation checks as needed
|
||||
id: validation-checks
|
||||
attributes:
|
||||
label: Validation Checks
|
||||
options:
|
||||
- label: it should validate ...
|
||||
- label: it shouldn't allow ...
|
||||
# Add more validation checks as needed
|
||||
|
||||
Loading…
Reference in New Issue
Block a user