From 6aa8208401110ca510914a3752fe06096090a94b Mon Sep 17 00:00:00 2001 From: Yingfeng <yingfeng.zhang@gmail.com> Date: Mon, 1 Apr 2024 11:31:38 +0800 Subject: [PATCH] Update README and github template (#186) --- .github/ISSUE_TEMPLATE/bug_report.yml | 67 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 10 ++++ .github/ISSUE_TEMPLATE/feature_request.yml | 46 +++++++++++++++ .github/ISSUE_TEMPLATE/question.yml | 15 +++++ .github/ISSUE_TEMPLATE/subtask.yml | 29 ++++++++++ .github/pull_request_template.md | 36 ++++-------- README.md | 2 +- README_zh.md | 2 +- 8 files changed, 181 insertions(+), 26 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml create mode 100644 .github/ISSUE_TEMPLATE/subtask.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..6318623 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..250b354 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,10 @@ +--- +name: Feature request +title: '[Feature Request]: ' +about: Suggest an idea for Infinity +labels: '' +--- + +**Summary** + +Description for this feature. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..83f057d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..f4186de --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/subtask.yml b/.github/ISSUE_TEMPLATE/subtask.yml new file mode 100644 index 0000000..35d0923 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/subtask.yml @@ -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 + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 1e68308..12ff5a2 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,29 +1,17 @@ ### 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 - -- [ ] Has Code change -- [ ] Has CI related scripts change - -### Check List - -Tests <!-- At least one of them must be included. --> - -- [ ] 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 +- [ ] Bug Fix (non-breaking change which fixes an issue) +- [ ] New Feature (non-breaking change which adds functionality) +- [ ] Breaking Change (fix or feature that could cause existing functionality not to work as expected) +- [ ] Documentation Update +- [ ] Refactoring +- [ ] Performance Improvement +- [ ] Test cases +- [ ] Python SDK impacted, Need to update PyPI +- [ ] Other (please describe): diff --git a/README.md b/README.md index 9d5bc56..820e1cc 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ ## đź’ˇ 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 diff --git a/README_zh.md b/README_zh.md index ed6c481..55a9991 100644 --- a/README_zh.md +++ b/README_zh.md @@ -22,7 +22,7 @@ ## đź’ˇ 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）é’对用ć·ĺ„类不ĺŚçš„ĺ¤Ťćť‚ć ĽĺĽŹć•°ćŤ®ćŹäľ›ĺŹŻéť çš„é—®ç”以及有ç†ćś‰ćŤ®çš„引用。 ## 🌟 主č¦ĺŠźč˝ -- GitLab