From 098f811ad27fe0396536c8a9ee891e1d81d7570c Mon Sep 17 00:00:00 2001 From: Yannick Stephan Date: Wed, 19 Feb 2025 20:07:34 +0100 Subject: [PATCH 1/2] add template github --- .github/ISSUE_TEMPLATE/bug_report.yml | 64 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.yml | 33 +++++++++++ .github/ISSUE_TEMPLATE/general_issue.yml | 58 ++++++++++++++++++++ .github/pull_request_template.md | 32 +++++++++++ 5 files changed, 188 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/general_issue.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..f2e3ad04 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,64 @@ +name: Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["bug", "triage"] + +body: + - type: checkboxes + id: existingcheck + attributes: + label: Do you need to file an issue? + description: Please help us manage our time by avoiding duplicates and common questions with the steps below. + options: + - label: I have searched the existing issues and this bug is not already filed. + - label: My model is hosted on OpenAI or Azure. If not, please look at the "model providers" issue and don't file a new one here. + - label: I believe this is a legitimate bug, not just a question. If this is a question, please use the Discussions area. + - type: textarea + id: description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + placeholder: What went wrong? + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce + description: Steps to reproduce the behavior. + placeholder: How can we replicate the issue? + - type: textarea + id: expected_behavior + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + placeholder: What should have happened? + - type: textarea + id: configused + attributes: + label: LightRAG Config Used + description: The LightRAG configuration used for the run. + placeholder: The settings.yaml content or LightRAG configuration + value: | + ```yaml + # Paste your config here + ``` + - type: textarea + id: screenshotslogs + attributes: + label: Logs and screenshots + description: If applicable, add screenshots and logs to help explain your problem. + placeholder: Add logs and screenshots here + - type: textarea + id: additional_information + attributes: + label: Additional Information + description: | + - LightRAG Version: e.g., v0.1.1 + - Operating System: e.g., Windows 10, Ubuntu 20.04 + - Python Version: e.g., 3.8 + - Related Issues: e.g., #1 + - Any other relevant information. + value: | + - LightRAG Version: + - Operating System: + - Python Version: + - Related Issues: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..0086358d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..aa2a6da7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,33 @@ +name: Feature Request +description: File a feature request +labels: ["enhancement"] +title: "[Feature Request]: <title>" + +body: + - type: checkboxes + id: existingcheck + attributes: + label: Do you need to file an issue? + description: Please help us manage our time by avoiding duplicates and common questions with the steps below. + options: + - label: I have searched the existing issues and this feature is not already filed. + - label: My model is hosted on OpenAI or Azure. If not, please look at the "model providers" issue and don't file a new one here. + - label: I believe this is a legitimate feature request, not just a question. If this is a question, please use the Discussions area. + - type: textarea + id: problem_description + attributes: + label: Problem Description + description: A clear and concise description of the problem you're trying to solve. + placeholder: What problem are you trying to solve? + - type: textarea + id: solution_description + attributes: + label: Proposed Solution + description: A clear and concise description of what you want to happen. + placeholder: How do you envision the solution? + - type: textarea + id: additional_context + attributes: + label: Additional Context + description: Add any other context or screenshots about the feature request here. + placeholder: Any additional information diff --git a/.github/ISSUE_TEMPLATE/general_issue.yml b/.github/ISSUE_TEMPLATE/general_issue.yml new file mode 100644 index 00000000..c023c2d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general_issue.yml @@ -0,0 +1,58 @@ +name: General Issue +description: File a general issue +title: "[Issue]: <title>" +labels: ["triage"] + +body: + - type: checkboxes + id: existingcheck + attributes: + label: Do you need to file an issue? + description: Please help us manage our time by avoiding duplicates and common questions with the steps below. + options: + - label: I have searched the existing issues and this issue is not already filed. + - label: My model is hosted on OpenAI or Azure. If not, please look at the "model providers" issue and don't file a new one here. + - label: I believe this is a legitimate issue, not just a question. If this is a question, please use the Discussions area. + - type: textarea + id: description + attributes: + label: Describe the issue + description: A clear and concise description of what the issue is. + placeholder: What went wrong? + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce + description: Steps to reproduce the behavior. + placeholder: How can we replicate the issue? + - type: textarea + id: configused + attributes: + label: LightRAG Config Used + description: The LightRAG configuration used for the run. + placeholder: The settings.yaml content or LightRAG configuration + value: | + ```yaml + # Paste your config here + ``` + - type: textarea + id: screenshotslogs + attributes: + label: Logs and screenshots + description: If applicable, add screenshots and logs to help explain your problem. + placeholder: Add logs and screenshots here + - type: textarea + id: additional_information + attributes: + label: Additional Information + description: | + - LightRAG Version: e.g., v0.1.1 + - Operating System: e.g., Windows 10, Ubuntu 20.04 + - Python Version: e.g., 3.8 + - Related Issues: e.g., #1 + - Any other relevant information. + value: | + - LightRAG Version: + - Operating System: + - Python Version: + - Related Issues: diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..6eb2f2ac --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,32 @@ +<!-- +Thanks for contributing to LightRAG! + +Please ensure your pull request is ready for review before submitting. + +About this template + +This template helps contributors provide a clear and concise description of their changes. Feel free to adjust it as needed. +--> + +## Description + +[Briefly describe the changes made in this pull request.] + +## Related Issues + +[Reference any related issues or tasks addressed by this pull request.] + +## Changes Made + +[List the specific changes made in this pull request.] + +## Checklist + +- [ ] Changes tested locally +- [ ] Code reviewed +- [ ] Documentation updated (if necessary) +- [ ] Unit tests added (if applicable) + +## Additional Notes + +[Add any additional notes or context for the reviewer(s).] From fb5938aac40768913d66552c8e21498a86a42d72 Mon Sep 17 00:00:00 2001 From: Yannick Stephan <stephan.yannick@me.com> Date: Wed, 19 Feb 2025 20:17:57 +0100 Subject: [PATCH 2/2] updated template --- .github/ISSUE_TEMPLATE/bug_report.yml | 3 -- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yml | 1 - .github/ISSUE_TEMPLATE/general_issue.yml | 58 ---------------------- .github/ISSUE_TEMPLATE/question.yml | 26 ++++++++++ 5 files changed, 27 insertions(+), 63 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/general_issue.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index f2e3ad04..35d55b99 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -11,7 +11,6 @@ body: description: Please help us manage our time by avoiding duplicates and common questions with the steps below. options: - label: I have searched the existing issues and this bug is not already filed. - - label: My model is hosted on OpenAI or Azure. If not, please look at the "model providers" issue and don't file a new one here. - label: I believe this is a legitimate bug, not just a question. If this is a question, please use the Discussions area. - type: textarea id: description @@ -38,9 +37,7 @@ body: description: The LightRAG configuration used for the run. placeholder: The settings.yaml content or LightRAG configuration value: | - ```yaml # Paste your config here - ``` - type: textarea id: screenshotslogs attributes: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 0086358d..3ba13e0c 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1 @@ -blank_issues_enabled: true +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index aa2a6da7..790fdb1e 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -11,7 +11,6 @@ body: description: Please help us manage our time by avoiding duplicates and common questions with the steps below. options: - label: I have searched the existing issues and this feature is not already filed. - - label: My model is hosted on OpenAI or Azure. If not, please look at the "model providers" issue and don't file a new one here. - label: I believe this is a legitimate feature request, not just a question. If this is a question, please use the Discussions area. - type: textarea id: problem_description diff --git a/.github/ISSUE_TEMPLATE/general_issue.yml b/.github/ISSUE_TEMPLATE/general_issue.yml deleted file mode 100644 index c023c2d9..00000000 --- a/.github/ISSUE_TEMPLATE/general_issue.yml +++ /dev/null @@ -1,58 +0,0 @@ -name: General Issue -description: File a general issue -title: "[Issue]: <title>" -labels: ["triage"] - -body: - - type: checkboxes - id: existingcheck - attributes: - label: Do you need to file an issue? - description: Please help us manage our time by avoiding duplicates and common questions with the steps below. - options: - - label: I have searched the existing issues and this issue is not already filed. - - label: My model is hosted on OpenAI or Azure. If not, please look at the "model providers" issue and don't file a new one here. - - label: I believe this is a legitimate issue, not just a question. If this is a question, please use the Discussions area. - - type: textarea - id: description - attributes: - label: Describe the issue - description: A clear and concise description of what the issue is. - placeholder: What went wrong? - - type: textarea - id: reproduce - attributes: - label: Steps to reproduce - description: Steps to reproduce the behavior. - placeholder: How can we replicate the issue? - - type: textarea - id: configused - attributes: - label: LightRAG Config Used - description: The LightRAG configuration used for the run. - placeholder: The settings.yaml content or LightRAG configuration - value: | - ```yaml - # Paste your config here - ``` - - type: textarea - id: screenshotslogs - attributes: - label: Logs and screenshots - description: If applicable, add screenshots and logs to help explain your problem. - placeholder: Add logs and screenshots here - - type: textarea - id: additional_information - attributes: - label: Additional Information - description: | - - LightRAG Version: e.g., v0.1.1 - - Operating System: e.g., Windows 10, Ubuntu 20.04 - - Python Version: e.g., 3.8 - - Related Issues: e.g., #1 - - Any other relevant information. - value: | - - LightRAG Version: - - Operating System: - - Python Version: - - Related Issues: diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 00000000..b8ed439d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,26 @@ +name: Question +description: Ask a general question +labels: ["question"] +title: "[Question]: <title>" + +body: + - type: checkboxes + id: existingcheck + attributes: + label: Do you need to ask a question? + description: Please help us manage our time by avoiding duplicates and common questions with the steps below. + options: + - label: I have searched the existing issues and discussions and this question is not already answered. + - label: I believe this is a legitimate question, not just a duplicate or common issue. + - type: textarea + id: question + attributes: + label: Your Question + description: A clear and concise description of your question. + placeholder: What is your question? + - type: textarea + id: context + attributes: + label: Additional Context + description: Provide any additional context or details that might help us understand your question better. + placeholder: Add any relevant information here