mirror of
https://github.com/infiniflow/ragflow.git
synced 2025-12-08 20:42:30 +08:00
Update README and github template (#186)
This commit is contained in:
67
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
67
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@ -0,0 +1,67 @@
|
||||
name: Bug Report
|
||||
description: Create a bug issue for infinity
|
||||
title: "[Bug]: "
|
||||
labels: [bug]
|
||||
body:
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Is there an existing issue for the same bug?
|
||||
description: Please check if an issue already exists for the bug you encountered.
|
||||
options:
|
||||
- label: I have checked the existing issues.
|
||||
required: true
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: "Please provide the following information to help us understand the issue."
|
||||
- type: input
|
||||
attributes:
|
||||
label: Branch name
|
||||
description: Enter the name of the branch where you encountered the issue.
|
||||
placeholder: e.g., main
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
attributes:
|
||||
label: Commit ID
|
||||
description: Enter the commit ID associated with the issue.
|
||||
placeholder: e.g., c3b2a1
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Other environment information
|
||||
description: |
|
||||
Enter the environment details:
|
||||
value: |
|
||||
- Hardware parameters:
|
||||
- OS type:
|
||||
- Others:
|
||||
render: Markdown
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Actual behavior
|
||||
description: Describe what you encountered.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Expected behavior
|
||||
description: Describe what you expected.
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: Steps to reproduce what you encountered.
|
||||
render: Markdown
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Additional information
|
||||
description: |
|
||||
Log, error message, or any other information can help find the root cause.
|
||||
validations:
|
||||
required: false
|
||||
10
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
10
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@ -0,0 +1,10 @@
|
||||
---
|
||||
name: Feature request
|
||||
title: '[Feature Request]: '
|
||||
about: Suggest an idea for Infinity
|
||||
labels: ''
|
||||
---
|
||||
|
||||
**Summary**
|
||||
|
||||
Description for this feature.
|
||||
46
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
46
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@ -0,0 +1,46 @@
|
||||
name: Feature request
|
||||
description: Propose a feature request for infinity.
|
||||
title: "[Feature Request]: "
|
||||
labels: [feature request]
|
||||
body:
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Is there an existing issue for the same feature request?
|
||||
description: Please check if an issue already exists for the feature you request.
|
||||
options:
|
||||
- label: I have checked the existing issues.
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Is your feature request related to a problem?
|
||||
description: |
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
render: Markdown
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Describe the feature you'd like
|
||||
description: A clear and concise description of what you want to happen.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Describe implementation you've considered
|
||||
description: A clear and concise description of implementation you've considered or investigated.
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Documentation, adoption, use case
|
||||
description: If you can, explain some scenarios how users might use this, situations it would be helpful in. Any API designs, mockups, or diagrams are also helpful.
|
||||
render: Markdown
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Additional information
|
||||
description: |
|
||||
Add any other context or screenshots about the feature request here.
|
||||
validations:
|
||||
required: false
|
||||
15
.github/ISSUE_TEMPLATE/question.yml
vendored
Normal file
15
.github/ISSUE_TEMPLATE/question.yml
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
name: Question
|
||||
description: Ask questions on infinity
|
||||
title: "[Question]: "
|
||||
labels: [question]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
If the previous templates don't fit with what you'd like to report or ask, please use this general question template to file issue.
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Describe your problem
|
||||
description: A clear and concise description of your problem.
|
||||
validations:
|
||||
required: true
|
||||
29
.github/ISSUE_TEMPLATE/subtask.yml
vendored
Normal file
29
.github/ISSUE_TEMPLATE/subtask.yml
vendored
Normal file
@ -0,0 +1,29 @@
|
||||
name: Subtask
|
||||
description: "Propose a subtask for infinity"
|
||||
title: "[Subtask]: "
|
||||
labels: [subtask]
|
||||
|
||||
body:
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Parent Issue
|
||||
description: Write the ID of the parent issue
|
||||
placeholder: "Parent issue: #"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Detail of Subtask
|
||||
description: |
|
||||
Describe the functions that this subtask should implement
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Describe implementation you've considered
|
||||
description: A clear and concise description of implementation you've considered or investigated.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
Reference in New Issue
Block a user