feat(kag) update template for issues (#114)

* [feat] add template for issues

* update template for issues

* update template for issues
This commit is contained in:
田常@蚂蚁 2024-12-10 09:46:31 +08:00 committed by GitHub
parent 849a81885f
commit 68b2c63346
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 8 additions and 127 deletions

View File

@ -3,12 +3,6 @@ title: "[Bug] [Module Name] Bug title "
description: Create a report to help us improve description: Create a report to help us improve
labels: [ "bug", "Waiting for reply" ] labels: [ "bug", "Waiting for reply" ]
body: body:
- type: markdown
attributes:
value: >
Thank you for taking the time to report a bug. The `[Module Name]` in title see
[here](https://github.com/OpenSPG/KAG/labels),
if you don't know the module name, you don't have to fill it in.
- type: checkboxes - type: checkboxes
attributes: attributes:
@ -36,52 +30,6 @@ body:
validations: validations:
required: true required: true
- type: dropdown
id: python-version
attributes:
label: Python version information
description: Python version you use
options:
- ">=3.11"
- "3.10"
- "<3.10"
validations:
required: true
- type: textarea
id: device-information
attributes:
label: Device information
description: Describe the device you use
placeholder: >
Device: CPU or GPU
If using GPU:
- GPU Count: 1
- GPU Memory: 24G
validations:
required: true
- type: textarea
id: models-information
attributes:
label: Models information
description: Describe the LLM and embedding model you use
placeholder: >
LLM:
"client_type": "maas",
"model": "",
"base_url": "",
Embedding model:
"vectorizer":"",
"model":"",
"base_url":"",
validations:
required: true
- type: textarea - type: textarea
attributes: attributes:
label: What happened label: What happened
@ -91,21 +39,6 @@ body:
validations: validations:
required: true required: true
- type: textarea
attributes:
label: What you expected to happen
description: What do you think went wrong?
placeholder: >
Thank you for your feedback! To better understand the issue:
1. Please describe why you believe the behavior is incorrect.
2. Share the relevant log segments or error messages. For UI issues, screenshots are appreciated.
3. For textual data, kindly copy and paste rather than using screenshots to facilitate easier searches in the future.
validations:
required: true
- type: textarea - type: textarea
attributes: attributes:
label: How to reproduce label: How to reproduce
@ -127,13 +60,6 @@ body:
validations: validations:
required: true required: true
- type: textarea
attributes:
label: Additional context
description: Any other context about the problem here?
placeholder: >
Add any other context about the problem here.
- type: checkboxes - type: checkboxes
attributes: attributes:
label: Are you willing to submit PR? label: Are you willing to submit PR?
@ -141,17 +67,13 @@ body:
It's completely optional, but if you're interested in contributing, we're here to help! It's completely optional, but if you're interested in contributing, we're here to help!
If you have insights on the solution, that's even better. KAG thrives on community support, If you have insights on the solution, that's even better. KAG thrives on community support,
and we warmly welcome new contributors. and we warmly welcome new contributors.
If you are willing to submit a PR to KAG,
feel free to [contact us](https://github.com/OpenSPG/KAG?tab=readme-ov-file#6-contact-us) to discuss cooperation in OpenSPG-KAG
options: options:
- label: Yes I am willing to submit a PR! - label: Yes I am willing to submit a PR!
- type: textarea
attributes:
label: How to contact Us
description: >
If you are willing to submit a PR to KAG,
there are different ways to [contact us](https://github.com/OpenSPG/KAG?tab=readme-ov-file#6-contact-us) to discuss cooperation in OpenSPG-KAG
- type: markdown - type: markdown
attributes: attributes:
value: "Thanks for completing our form!" value: "Thanks for completing our form!"

View File

@ -3,12 +3,6 @@ description: Suggest an improvement or report a bug for this project's Documenta
title: "[Doc][Module Name] Documentation bug or improvement" title: "[Doc][Module Name] Documentation bug or improvement"
labels: [ "documentation", "Waiting for reply" ] labels: [ "documentation", "Waiting for reply" ]
body: body:
- type: markdown
attributes:
value: >
Thank you for taking the time to suggest an improvement or report a bug for this project's documentation.
The `[Module Name]` in title see [here](https://github.com/OpenSPG/KAG/labels),
if you don't know the module name, you don't have to fill it in.
- type: checkboxes - type: checkboxes
attributes: attributes:
@ -27,11 +21,6 @@ body:
label: Description label: Description
description: A short description why your find in our document. description: A short description why your find in our document.
- type: textarea
attributes:
label: Documentation Links
description: Copy and paste one or more links of this documentation issue.
- type: checkboxes - type: checkboxes
attributes: attributes:

View File

@ -3,12 +3,6 @@ description: Suggest an idea for this project
title: "[Feature][Module Name] Feature title" title: "[Feature][Module Name] Feature title"
labels: [ "enhancement", "Waiting for reply" ] labels: [ "enhancement", "Waiting for reply" ]
body: body:
- type: markdown
attributes:
value: >
Thank you for taking the time to suggest an idea for this project.
The `[Module Name]` in title see [here](https://github.com/OpenSPG/KAG/labels),
if you don't know the module name, you don't have to fill it in.
- type: checkboxes - type: checkboxes
attributes: attributes:
@ -26,29 +20,9 @@ body:
attributes: attributes:
label: Description label: Description
description: A short description of your feature description: A short description of your feature
- type: textarea
attributes:
label: Use case
description: What do you want to happen?
placeholder: > placeholder: >
Instead of detailing how to implement the feature, please describe your end goal or what you aim to achieve. Instead of detailing how to implement the feature, please describe your end goal or what you aim to achieve.
- type: textarea
attributes:
label: Related issues
description: Is there currently another issue associated with this?
- type: dropdown
id: priority
attributes:
label: Feature Priority
description: How would you rank the importance of this feature?
options:
- High
- Medium
- Low
- type: checkboxes - type: checkboxes
attributes: attributes:
label: Are you willing to submit PR? label: Are you willing to submit PR?
@ -56,17 +30,13 @@ body:
It's completely optional, but if you're interested in contributing, we're here to help! It's completely optional, but if you're interested in contributing, we're here to help!
If you have insights on the solution, that's even better. KAG thrives on community support, If you have insights on the solution, that's even better. KAG thrives on community support,
and we warmly welcome new contributors. and we warmly welcome new contributors.
If you are willing to submit a PR to KAG,
feel free to [contact us](https://github.com/OpenSPG/KAG?tab=readme-ov-file#6-contact-us) to discuss cooperation in OpenSPG-KAG
options: options:
- label: Yes I am willing to submit a PR! - label: Yes I am willing to submit a PR!
- type: textarea
attributes:
label: How to contact Us
description: >
If you are willing to submit a PR to KAG,
there are different ways to [contact us](https://github.com/OpenSPG/KAG?tab=readme-ov-file#6-contact-us) to discuss cooperation in OpenSPG-KAG
- type: markdown - type: markdown
attributes: attributes:
value: "Thanks for completing our form!" value: "Thanks for completing our form!"