mirror of
https://github.com/QuivrHQ/quivr.git
synced 2024-12-15 09:32:22 +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"]
|
labels: ["epic"]
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
**The Why**
|
**The Why**
|
||||||
|
|
||||||
Explain the reasons for this epic.
|
Explain the reasons for this epic.
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: why-value
|
id: why-value
|
||||||
attributes:
|
attributes:
|
||||||
label: Why do we need this functionality?
|
label: Why do we need this functionality?
|
||||||
description: What's the value? For whom?
|
description: What's the value? For whom?
|
||||||
placeholder: Detail the reasons here...
|
placeholder: Detail the reasons here...
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
**The What**
|
**The What**
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: developing
|
id: developing
|
||||||
attributes:
|
attributes:
|
||||||
label: What are we developing?
|
label: What are we developing?
|
||||||
description: What’s the expected behaviour? How should it look like?
|
description: What’s the expected behaviour? How should it look like?
|
||||||
placeholder: Describe the functionality or feature here...
|
placeholder: Describe the functionality or feature here...
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: validation-criteria
|
id: validation-criteria
|
||||||
attributes:
|
attributes:
|
||||||
label: What are the validation criteria to validate this feature?
|
label: What are the validation criteria to validate this feature?
|
||||||
description: Testing criteria, edge cases, error behavior, etc.
|
description: Testing criteria, edge cases, error behavior, etc.
|
||||||
placeholder: Detail the validation criteria here...
|
placeholder: Detail the validation criteria here...
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: out-of-scope
|
id: out-of-scope
|
||||||
attributes:
|
attributes:
|
||||||
label: What's out of scope for this feature?
|
label: What's out of scope for this feature?
|
||||||
placeholder: Detail what's not covered by this epic...
|
placeholder: Detail what's not covered by this epic...
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
id: feature-flagged
|
id: feature-flagged
|
||||||
attributes:
|
attributes:
|
||||||
label: Should this feature be feature flagged?
|
label: Should this feature be feature flagged?
|
||||||
options:
|
options:
|
||||||
- label: Yes
|
- label: Yes
|
||||||
- label: No
|
- label: No
|
||||||
|
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
**The How**
|
**The How**
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: code-strategy
|
id: code-strategy
|
||||||
attributes:
|
attributes:
|
||||||
label: How are we going to code this feature?
|
label: How are we going to code this feature?
|
||||||
description: Technical strategy, impacts, consequences, etc.
|
description: Technical strategy, impacts, consequences, etc.
|
||||||
placeholder: Describe the technical approach here...
|
placeholder: Describe the technical approach here...
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: technical-decisions
|
id: technical-decisions
|
||||||
attributes:
|
attributes:
|
||||||
label: Are there any technical decisions made that should be shared?
|
label: Are there any technical decisions made that should be shared?
|
||||||
placeholder: Detail the decisions here...
|
placeholder: Detail the decisions here...
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: blockers
|
id: blockers
|
||||||
attributes:
|
attributes:
|
||||||
label: What is preventing us from delivering this feature?
|
label: What is preventing us from delivering this feature?
|
||||||
placeholder: Detail any dependencies, issues, or blockers here...
|
placeholder: Detail any dependencies, issues, or blockers here...
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: potential-breaks
|
id: potential-breaks
|
||||||
attributes:
|
attributes:
|
||||||
label: What can the feature potentially break?
|
label: What can the feature potentially break?
|
||||||
placeholder: Detail any potential side effects or issues here...
|
placeholder: Detail any potential side effects or issues here...
|
||||||
validations:
|
validations:
|
||||||
required: true
|
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"]
|
labels: ["enhancement"]
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
Thanks for making Quivr better!
|
Thanks for making Quivr better!
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: the-feature
|
id: the-feature
|
||||||
attributes:
|
attributes:
|
||||||
label: The Feature
|
label: The Feature
|
||||||
description: A clear and concise description of the feature proposal
|
description: A clear and concise description of the feature proposal
|
||||||
placeholder: Tell us what you want!
|
placeholder: Tell us what you want!
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: motivation
|
id: motivation
|
||||||
attributes:
|
attributes:
|
||||||
label: Motivation, pitch
|
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.
|
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:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: input
|
- type: input
|
||||||
id: contact
|
id: contact
|
||||||
attributes:
|
attributes:
|
||||||
label: Twitter / LinkedIn details
|
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!
|
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/>
|
placeholder: ex. @_StanGirard/ <https://www.linkedin.com/in/stanislas-girard/>
|
||||||
validations:
|
validations:
|
||||||
required: false
|
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]: "
|
title: "[Bug]: "
|
||||||
labels: ["bug"]
|
labels: ["bug"]
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
Thanks for taking the time to fill out this bug report!
|
Thanks for taking the time to fill out this bug report!
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: what-happened
|
id: what-happened
|
||||||
attributes:
|
attributes:
|
||||||
label: What happened?
|
label: What happened?
|
||||||
description: Also tell us, what did you expect to happen?
|
description: Also tell us, what did you expect to happen?
|
||||||
placeholder: Tell us what you see!
|
placeholder: Tell us what you see!
|
||||||
value: "A bug happened!"
|
value: "A bug happened!"
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: logs
|
id: logs
|
||||||
attributes:
|
attributes:
|
||||||
label: Relevant log output
|
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.
|
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
|
||||||
render: shell
|
render: shell
|
||||||
- type: input
|
- type: input
|
||||||
id: contact
|
id: contact
|
||||||
attributes:
|
attributes:
|
||||||
label: Twitter / LinkedIn details
|
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!
|
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/>>
|
placeholder: ex. @_StanGirard / <<https://www.linkedin.com/in/stanislas-girard/>>
|
||||||
validations:
|
validations:
|
||||||
required: false
|
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"]
|
labels: ["user story"]
|
||||||
body:
|
body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
**Epic**
|
**Epic**
|
||||||
|
|
||||||
Include the issue that represents the epic.
|
Include the issue that represents the epic.
|
||||||
|
|
||||||
- type: input
|
- type: input
|
||||||
id: epic-link
|
id: epic-link
|
||||||
attributes:
|
attributes:
|
||||||
label: Link to the Epic
|
label: Link to the Epic
|
||||||
placeholder: Paste the link to the related epic here...
|
placeholder: Paste the link to the related epic here...
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
**Functional**
|
**Functional**
|
||||||
|
|
||||||
Detail the functionality and provide context and motivation.
|
Detail the functionality and provide context and motivation.
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: functionality-detail
|
id: functionality-detail
|
||||||
attributes:
|
attributes:
|
||||||
label: Explain the Functionality
|
label: Explain the Functionality
|
||||||
placeholder: Detail the user story functionality here...
|
placeholder: Detail the user story functionality here...
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
**Schema**
|
**Schema**
|
||||||
|
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
### Tech
|
### Tech
|
||||||
|
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
id: tech-todo
|
id: tech-todo
|
||||||
attributes:
|
attributes:
|
||||||
label: Tech To-dos
|
label: Tech To-dos
|
||||||
options:
|
options:
|
||||||
- label: To-do Item 1
|
- label: To-do Item 1
|
||||||
- label: To-do Item 2
|
- label: To-do Item 2
|
||||||
# Add more to-dos as needed
|
# Add more to-dos as needed
|
||||||
|
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
### Tests
|
### Tests
|
||||||
|
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
id: tests
|
id: tests
|
||||||
attributes:
|
attributes:
|
||||||
label: Test Cases
|
label: Test Cases
|
||||||
options:
|
options:
|
||||||
- label: it should ...
|
- label: it should ...
|
||||||
- label: it can ...
|
- label: it can ...
|
||||||
# Add more test cases as needed
|
# Add more test cases as needed
|
||||||
|
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
### Validation Checks
|
### Validation Checks
|
||||||
|
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
id: validation-checks
|
id: validation-checks
|
||||||
attributes:
|
attributes:
|
||||||
label: Validation Checks
|
label: Validation Checks
|
||||||
options:
|
options:
|
||||||
- label: it should validate ...
|
- label: it should validate ...
|
||||||
- label: it shouldn't allow ...
|
- label: it shouldn't allow ...
|
||||||
# Add more validation checks as needed
|
# Add more validation checks as needed
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user