Skip to content
Snippets Groups Projects
Unverified Commit 6aa82084 authored by Yingfeng's avatar Yingfeng Committed by GitHub
Browse files

Update README and github template (#186)

parent 87778515
No related branches found
No related tags found
No related merge requests found
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
\ No newline at end of file
---
name: Feature request
title: '[Feature Request]: '
about: Suggest an idea for Infinity
labels: ''
---
**Summary**
Description for this feature.
\ No newline at end of file
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
\ No newline at end of file
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
\ No newline at end of file
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
### What problem does this PR solve? ### What problem does this PR solve?
Add corresponding issue link with summary if exists --> _Briefly describe what this PR aims to solve. Include background context that will help reviewers understand the purpose of the PR._
Issue link: Issue link:#[Link the issue here]
### What is changed and how it works? ### Type of change
### Code changes - [ ] Bug Fix (non-breaking change which fixes an issue)
- [ ] New Feature (non-breaking change which adds functionality)
- [ ] Has Code change - [ ] Breaking Change (fix or feature that could cause existing functionality not to work as expected)
- [ ] Has CI related scripts change - [ ] Documentation Update
- [ ] Refactoring
### Check List - [ ] Performance Improvement
- [ ] Test cases
Tests <!-- At least one of them must be included. --> - [ ] Python SDK impacted, Need to update PyPI
- [ ] Other (please describe):
- [ ] Unit test
- [ ] Integration test
- [ ] Manual test (add detailed scripts or steps below)
- [ ] No code
Side effects
- [ ] Performance regression: Consumes more CPU
- [ ] Performance regression: Consumes more Memory
- [ ] Breaking backward compatibility
### Note for reviewer
...@@ -22,7 +22,7 @@ ...@@ -22,7 +22,7 @@
## 💡 What is RAGFlow? ## 💡 What is RAGFlow?
[RAGFlow](http://demo.ragflow.io) is an open-source, Retrieval-Augmented Generation engine built on large language models (LLM) and deep document understanding. It offers a streamlined RAG workflow for businesses of any scale, providing truthful responses with solid citations through a generative AI knowledge management platform. [RAGFlow](https://demo.ragflow.io) is an open-source RAG (Retrieval-Augmented Generation) engine based on deep document understanding. It offers a streamlined RAG workflow for businesses of any scale, combining LLM (Large Language Models) to provide truthful question-answering with well-founded citations for various complex fomatted data.
## 🌟 Key Features ## 🌟 Key Features
......
...@@ -22,7 +22,7 @@ ...@@ -22,7 +22,7 @@
## 💡 RAGFlow 是什么? ## 💡 RAGFlow 是什么?
[RAGFlow](http://demo.ragflow.io) 是一款基于大型语言模型(LLM)以及深度文档理解构建的开源检索增强型生成引擎(Retrieval-Augmented Generation Engine)。RAGFlow 可以为各种规模的企业提供一套精简的 RAG 工作流程,通过生成式 AI (Generative AI)知识管理平台提供可靠的问答以及有理有据的引用。 [RAGFlow](https://demo.ragflow.io) 是一款基于深度文档理解构建的开源 RAG(Retrieval-Augmented Generation)引擎。RAGFlow 可以为各种规模的企业及个人提供一套精简的 RAG 工作流程,结合大语言模型(LLM)针对用户各类不同的复杂格式数据提供可靠的问答以及有理有据的引用。
## 🌟 主要功能 ## 🌟 主要功能
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment