Yingfeng commited on
Commit
4e04a1e
·
1 Parent(s): 77116a5

Update README and github template (#186)

Browse files
.github/ISSUE_TEMPLATE/bug_report.yml ADDED
@@ -0,0 +1,67 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Bug Report
2
+ description: Create a bug issue for infinity
3
+ title: "[Bug]: "
4
+ labels: [bug]
5
+ body:
6
+ - type: checkboxes
7
+ attributes:
8
+ label: Is there an existing issue for the same bug?
9
+ description: Please check if an issue already exists for the bug you encountered.
10
+ options:
11
+ - label: I have checked the existing issues.
12
+ required: true
13
+ - type: markdown
14
+ attributes:
15
+ value: "Please provide the following information to help us understand the issue."
16
+ - type: input
17
+ attributes:
18
+ label: Branch name
19
+ description: Enter the name of the branch where you encountered the issue.
20
+ placeholder: e.g., main
21
+ validations:
22
+ required: true
23
+ - type: input
24
+ attributes:
25
+ label: Commit ID
26
+ description: Enter the commit ID associated with the issue.
27
+ placeholder: e.g., c3b2a1
28
+ validations:
29
+ required: true
30
+ - type: textarea
31
+ attributes:
32
+ label: Other environment information
33
+ description: |
34
+ Enter the environment details:
35
+ value: |
36
+ - Hardware parameters:
37
+ - OS type:
38
+ - Others:
39
+ render: Markdown
40
+ validations:
41
+ required: false
42
+ - type: textarea
43
+ attributes:
44
+ label: Actual behavior
45
+ description: Describe what you encountered.
46
+ validations:
47
+ required: true
48
+ - type: textarea
49
+ attributes:
50
+ label: Expected behavior
51
+ description: Describe what you expected.
52
+ validations:
53
+ required: false
54
+ - type: textarea
55
+ attributes:
56
+ label: Steps to reproduce
57
+ description: Steps to reproduce what you encountered.
58
+ render: Markdown
59
+ validations:
60
+ required: true
61
+ - type: textarea
62
+ attributes:
63
+ label: Additional information
64
+ description: |
65
+ Log, error message, or any other information can help find the root cause.
66
+ validations:
67
+ required: false
.github/ISSUE_TEMPLATE/feature_request.md ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ name: Feature request
3
+ title: '[Feature Request]: '
4
+ about: Suggest an idea for Infinity
5
+ labels: ''
6
+ ---
7
+
8
+ **Summary**
9
+
10
+ Description for this feature.
.github/ISSUE_TEMPLATE/feature_request.yml ADDED
@@ -0,0 +1,46 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Feature request
2
+ description: Propose a feature request for infinity.
3
+ title: "[Feature Request]: "
4
+ labels: [feature request]
5
+ body:
6
+ - type: checkboxes
7
+ attributes:
8
+ label: Is there an existing issue for the same feature request?
9
+ description: Please check if an issue already exists for the feature you request.
10
+ options:
11
+ - label: I have checked the existing issues.
12
+ required: true
13
+ - type: textarea
14
+ attributes:
15
+ label: Is your feature request related to a problem?
16
+ description: |
17
+ A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
18
+ render: Markdown
19
+ validations:
20
+ required: false
21
+ - type: textarea
22
+ attributes:
23
+ label: Describe the feature you'd like
24
+ description: A clear and concise description of what you want to happen.
25
+ validations:
26
+ required: true
27
+ - type: textarea
28
+ attributes:
29
+ label: Describe implementation you've considered
30
+ description: A clear and concise description of implementation you've considered or investigated.
31
+ validations:
32
+ required: false
33
+ - type: textarea
34
+ attributes:
35
+ label: Documentation, adoption, use case
36
+ 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.
37
+ render: Markdown
38
+ validations:
39
+ required: false
40
+ - type: textarea
41
+ attributes:
42
+ label: Additional information
43
+ description: |
44
+ Add any other context or screenshots about the feature request here.
45
+ validations:
46
+ required: false
.github/ISSUE_TEMPLATE/question.yml ADDED
@@ -0,0 +1,15 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Question
2
+ description: Ask questions on infinity
3
+ title: "[Question]: "
4
+ labels: [question]
5
+ body:
6
+ - type: markdown
7
+ attributes:
8
+ value: |
9
+ 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.
10
+ - type: textarea
11
+ attributes:
12
+ label: Describe your problem
13
+ description: A clear and concise description of your problem.
14
+ validations:
15
+ required: true
.github/ISSUE_TEMPLATE/subtask.yml ADDED
@@ -0,0 +1,29 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Subtask
2
+ description: "Propose a subtask for infinity"
3
+ title: "[Subtask]: "
4
+ labels: [subtask]
5
+
6
+ body:
7
+ - type: textarea
8
+ attributes:
9
+ label: Parent Issue
10
+ description: Write the ID of the parent issue
11
+ placeholder: "Parent issue: #"
12
+ validations:
13
+ required: true
14
+
15
+ - type: textarea
16
+ attributes:
17
+ label: Detail of Subtask
18
+ description: |
19
+ Describe the functions that this subtask should implement
20
+ validations:
21
+ required: true
22
+
23
+ - type: textarea
24
+ attributes:
25
+ label: Describe implementation you've considered
26
+ description: A clear and concise description of implementation you've considered or investigated.
27
+ validations:
28
+ required: false
29
+
.github/pull_request_template.md CHANGED
@@ -1,29 +1,17 @@
1
  ### What problem does this PR solve?
2
 
3
- Add corresponding issue link with summary if exists -->
4
 
5
- Issue link:
6
 
7
- ### What is changed and how it works?
8
 
9
- ### Code changes
10
-
11
- - [ ] Has Code change
12
- - [ ] Has CI related scripts change
13
-
14
- ### Check List
15
-
16
- Tests <!-- At least one of them must be included. -->
17
-
18
- - [ ] Unit test
19
- - [ ] Integration test
20
- - [ ] Manual test (add detailed scripts or steps below)
21
- - [ ] No code
22
-
23
- Side effects
24
-
25
- - [ ] Performance regression: Consumes more CPU
26
- - [ ] Performance regression: Consumes more Memory
27
- - [ ] Breaking backward compatibility
28
-
29
- ### Note for reviewer
 
1
  ### What problem does this PR solve?
2
 
3
+ _Briefly describe what this PR aims to solve. Include background context that will help reviewers understand the purpose of the PR._
4
 
5
+ Issue link:#[Link the issue here]
6
 
7
+ ### Type of change
8
 
9
+ - [ ] Bug Fix (non-breaking change which fixes an issue)
10
+ - [ ] New Feature (non-breaking change which adds functionality)
11
+ - [ ] Breaking Change (fix or feature that could cause existing functionality not to work as expected)
12
+ - [ ] Documentation Update
13
+ - [ ] Refactoring
14
+ - [ ] Performance Improvement
15
+ - [ ] Test cases
16
+ - [ ] Python SDK impacted, Need to update PyPI
17
+ - [ ] Other (please describe):
 
 
 
 
 
 
 
 
 
 
 
 
README.md CHANGED
@@ -22,7 +22,7 @@
22
 
23
  ## 💡 What is RAGFlow?
24
 
25
- [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.
26
 
27
  ## 🌟 Key Features
28
 
 
22
 
23
  ## 💡 What is RAGFlow?
24
 
25
+ [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.
26
 
27
  ## 🌟 Key Features
28
 
README_zh.md CHANGED
@@ -22,7 +22,7 @@
22
 
23
  ## 💡 RAGFlow 是什么?
24
 
25
- [RAGFlow](http://demo.ragflow.io) 是一款基于大型语言模型(LLM)以及深度文档理解构建的开源检索增强型生成引擎(Retrieval-Augmented Generation Engine)。RAGFlow 可以为各种规模的企业提供一套精简的 RAG 工作流程,通过生成式 AI (Generative AI)知识管理平台提供可靠的问答以及有理有据的引用。
26
 
27
  ## 🌟 主要功能
28
 
 
22
 
23
  ## 💡 RAGFlow 是什么?
24
 
25
+ [RAGFlow](https://demo.ragflow.io) 是一款基于深度文档理解构建的开源 RAG(Retrieval-Augmented Generation)引擎。RAGFlow 可以为各种规模的企业及个人提供一套精简的 RAG 工作流程,结合大语言模型(LLM)针对用户各类不同的复杂格式数据提供可靠的问答以及有理有据的引用。
26
 
27
  ## 🌟 主要功能
28