mirror of
https://github.com/imartinez/privateGPT.git
synced 2025-07-13 15:14:09 +00:00
chore: add issue templates
This commit is contained in:
parent
22748bff9a
commit
bdd0bb7425
71
.github/ISSUE_TEMPLATE/bug.yml
vendored
Normal file
71
.github/ISSUE_TEMPLATE/bug.yml
vendored
Normal file
@ -0,0 +1,71 @@
|
|||||||
|
name: Bug Report
|
||||||
|
description: Report a bug or issue with the project.
|
||||||
|
title: "[BUG] "
|
||||||
|
labels: ["bug"]
|
||||||
|
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
**Please describe the bug you encountered.**
|
||||||
|
|
||||||
|
- type: checkboxes
|
||||||
|
id: pre-check
|
||||||
|
attributes:
|
||||||
|
label: Pre-check
|
||||||
|
description: Please confirm that you have searched for duplicate issues before creating this one.
|
||||||
|
options:
|
||||||
|
- label: I have searched the existing issues and none cover this bug.
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Description
|
||||||
|
description: Provide a detailed description of the bug.
|
||||||
|
placeholder: "Detailed description of the bug"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: steps
|
||||||
|
attributes:
|
||||||
|
label: Steps to Reproduce
|
||||||
|
description: Provide the steps to reproduce the bug.
|
||||||
|
placeholder: "1. Step one\n2. Step two\n3. Step three"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: expected
|
||||||
|
attributes:
|
||||||
|
label: Expected Behavior
|
||||||
|
description: Describe what you expected to happen.
|
||||||
|
placeholder: "Expected behavior"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: actual
|
||||||
|
attributes:
|
||||||
|
label: Actual Behavior
|
||||||
|
description: Describe what actually happened.
|
||||||
|
placeholder: "Actual behavior"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: environment
|
||||||
|
attributes:
|
||||||
|
label: Environment
|
||||||
|
description: Provide details about your environment (e.g., OS, browser, Node version).
|
||||||
|
placeholder: "Environment details"
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: version
|
||||||
|
attributes:
|
||||||
|
label: Version
|
||||||
|
description: Provide the version of the project where you encountered the bug.
|
||||||
|
placeholder: "Version number"
|
||||||
|
validations:
|
||||||
|
required: true
|
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
8
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: Documentation
|
||||||
|
url: https://docs.privategpt.dev
|
||||||
|
about: Please refer to our documentation for more details and guidance.
|
||||||
|
- name: Discord
|
||||||
|
url: https://discord.gg/bK6mRVpErU
|
||||||
|
about: Join our Discord community to ask questions and get help.
|
19
.github/ISSUE_TEMPLATE/docs.yml
vendored
Normal file
19
.github/ISSUE_TEMPLATE/docs.yml
vendored
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
name: Documentation
|
||||||
|
description: Suggest a change or addition to the documentation.
|
||||||
|
title: "[DOCS] "
|
||||||
|
labels: ["documentation"]
|
||||||
|
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
**Please describe the documentation change or addition you would like to suggest.**
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Description
|
||||||
|
description: Provide a detailed description of the documentation change.
|
||||||
|
placeholder: "Detailed description of the documentation change"
|
||||||
|
validations:
|
||||||
|
required: true
|
37
.github/ISSUE_TEMPLATE/feature.yml
vendored
Normal file
37
.github/ISSUE_TEMPLATE/feature.yml
vendored
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
name: Enhancement
|
||||||
|
description: Suggest an enhancement or improvement to the project.
|
||||||
|
title: "[FEATURE] "
|
||||||
|
labels: ["enhancement"]
|
||||||
|
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
**Please describe the enhancement or improvement you would like to suggest.**
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: feature_description
|
||||||
|
attributes:
|
||||||
|
label: Feature Description
|
||||||
|
description: Provide a detailed description of the enhancement.
|
||||||
|
placeholder: "Detailed description of the enhancement"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: reason
|
||||||
|
attributes:
|
||||||
|
label: Reason
|
||||||
|
description: Explain the reason for this enhancement.
|
||||||
|
placeholder: "Reason for the enhancement"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: value
|
||||||
|
attributes:
|
||||||
|
label: Value of Feature
|
||||||
|
description: Describe the value or benefits this feature will bring.
|
||||||
|
placeholder: "Value or benefits of the feature"
|
||||||
|
validations:
|
||||||
|
required: true
|
19
.github/ISSUE_TEMPLATE/question.yml
vendored
Normal file
19
.github/ISSUE_TEMPLATE/question.yml
vendored
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
name: Question
|
||||||
|
description: Ask a question about the project.
|
||||||
|
title: "[QUESTION] "
|
||||||
|
labels: ["question"]
|
||||||
|
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
**Please describe your question in detail.**
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: question
|
||||||
|
attributes:
|
||||||
|
label: Question
|
||||||
|
description: Provide a detailed description of your question.
|
||||||
|
placeholder: "Detailed description of the question"
|
||||||
|
validations:
|
||||||
|
required: true
|
Loading…
Reference in New Issue
Block a user