YanSte commited on
Commit
b17d8f0
·
1 Parent(s): 0becc4b

add template github

Browse files
.github/ISSUE_TEMPLATE/bug_report.yml ADDED
@@ -0,0 +1,64 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Bug Report
2
+ description: File a bug report
3
+ title: "[Bug]: <title>"
4
+ labels: ["bug", "triage"]
5
+
6
+ body:
7
+ - type: checkboxes
8
+ id: existingcheck
9
+ attributes:
10
+ label: Do you need to file an issue?
11
+ description: Please help us manage our time by avoiding duplicates and common questions with the steps below.
12
+ options:
13
+ - label: I have searched the existing issues and this bug is not already filed.
14
+ - 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.
15
+ - label: I believe this is a legitimate bug, not just a question. If this is a question, please use the Discussions area.
16
+ - type: textarea
17
+ id: description
18
+ attributes:
19
+ label: Describe the bug
20
+ description: A clear and concise description of what the bug is.
21
+ placeholder: What went wrong?
22
+ - type: textarea
23
+ id: reproduce
24
+ attributes:
25
+ label: Steps to reproduce
26
+ description: Steps to reproduce the behavior.
27
+ placeholder: How can we replicate the issue?
28
+ - type: textarea
29
+ id: expected_behavior
30
+ attributes:
31
+ label: Expected Behavior
32
+ description: A clear and concise description of what you expected to happen.
33
+ placeholder: What should have happened?
34
+ - type: textarea
35
+ id: configused
36
+ attributes:
37
+ label: LightRAG Config Used
38
+ description: The LightRAG configuration used for the run.
39
+ placeholder: The settings.yaml content or LightRAG configuration
40
+ value: |
41
+ ```yaml
42
+ # Paste your config here
43
+ ```
44
+ - type: textarea
45
+ id: screenshotslogs
46
+ attributes:
47
+ label: Logs and screenshots
48
+ description: If applicable, add screenshots and logs to help explain your problem.
49
+ placeholder: Add logs and screenshots here
50
+ - type: textarea
51
+ id: additional_information
52
+ attributes:
53
+ label: Additional Information
54
+ description: |
55
+ - LightRAG Version: e.g., v0.1.1
56
+ - Operating System: e.g., Windows 10, Ubuntu 20.04
57
+ - Python Version: e.g., 3.8
58
+ - Related Issues: e.g., #1
59
+ - Any other relevant information.
60
+ value: |
61
+ - LightRAG Version:
62
+ - Operating System:
63
+ - Python Version:
64
+ - Related Issues:
.github/ISSUE_TEMPLATE/config.yml ADDED
@@ -0,0 +1 @@
 
 
1
+ blank_issues_enabled: true
.github/ISSUE_TEMPLATE/feature_request.yml ADDED
@@ -0,0 +1,33 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: Feature Request
2
+ description: File a feature request
3
+ labels: ["enhancement"]
4
+ title: "[Feature Request]: <title>"
5
+
6
+ body:
7
+ - type: checkboxes
8
+ id: existingcheck
9
+ attributes:
10
+ label: Do you need to file an issue?
11
+ description: Please help us manage our time by avoiding duplicates and common questions with the steps below.
12
+ options:
13
+ - label: I have searched the existing issues and this feature is not already filed.
14
+ - 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.
15
+ - label: I believe this is a legitimate feature request, not just a question. If this is a question, please use the Discussions area.
16
+ - type: textarea
17
+ id: problem_description
18
+ attributes:
19
+ label: Problem Description
20
+ description: A clear and concise description of the problem you're trying to solve.
21
+ placeholder: What problem are you trying to solve?
22
+ - type: textarea
23
+ id: solution_description
24
+ attributes:
25
+ label: Proposed Solution
26
+ description: A clear and concise description of what you want to happen.
27
+ placeholder: How do you envision the solution?
28
+ - type: textarea
29
+ id: additional_context
30
+ attributes:
31
+ label: Additional Context
32
+ description: Add any other context or screenshots about the feature request here.
33
+ placeholder: Any additional information
.github/ISSUE_TEMPLATE/general_issue.yml ADDED
@@ -0,0 +1,58 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ name: General Issue
2
+ description: File a general issue
3
+ title: "[Issue]: <title>"
4
+ labels: ["triage"]
5
+
6
+ body:
7
+ - type: checkboxes
8
+ id: existingcheck
9
+ attributes:
10
+ label: Do you need to file an issue?
11
+ description: Please help us manage our time by avoiding duplicates and common questions with the steps below.
12
+ options:
13
+ - label: I have searched the existing issues and this issue is not already filed.
14
+ - 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.
15
+ - label: I believe this is a legitimate issue, not just a question. If this is a question, please use the Discussions area.
16
+ - type: textarea
17
+ id: description
18
+ attributes:
19
+ label: Describe the issue
20
+ description: A clear and concise description of what the issue is.
21
+ placeholder: What went wrong?
22
+ - type: textarea
23
+ id: reproduce
24
+ attributes:
25
+ label: Steps to reproduce
26
+ description: Steps to reproduce the behavior.
27
+ placeholder: How can we replicate the issue?
28
+ - type: textarea
29
+ id: configused
30
+ attributes:
31
+ label: LightRAG Config Used
32
+ description: The LightRAG configuration used for the run.
33
+ placeholder: The settings.yaml content or LightRAG configuration
34
+ value: |
35
+ ```yaml
36
+ # Paste your config here
37
+ ```
38
+ - type: textarea
39
+ id: screenshotslogs
40
+ attributes:
41
+ label: Logs and screenshots
42
+ description: If applicable, add screenshots and logs to help explain your problem.
43
+ placeholder: Add logs and screenshots here
44
+ - type: textarea
45
+ id: additional_information
46
+ attributes:
47
+ label: Additional Information
48
+ description: |
49
+ - LightRAG Version: e.g., v0.1.1
50
+ - Operating System: e.g., Windows 10, Ubuntu 20.04
51
+ - Python Version: e.g., 3.8
52
+ - Related Issues: e.g., #1
53
+ - Any other relevant information.
54
+ value: |
55
+ - LightRAG Version:
56
+ - Operating System:
57
+ - Python Version:
58
+ - Related Issues:
.github/pull_request_template.md ADDED
@@ -0,0 +1,32 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!--
2
+ Thanks for contributing to LightRAG!
3
+
4
+ Please ensure your pull request is ready for review before submitting.
5
+
6
+ About this template
7
+
8
+ This template helps contributors provide a clear and concise description of their changes. Feel free to adjust it as needed.
9
+ -->
10
+
11
+ ## Description
12
+
13
+ [Briefly describe the changes made in this pull request.]
14
+
15
+ ## Related Issues
16
+
17
+ [Reference any related issues or tasks addressed by this pull request.]
18
+
19
+ ## Changes Made
20
+
21
+ [List the specific changes made in this pull request.]
22
+
23
+ ## Checklist
24
+
25
+ - [ ] Changes tested locally
26
+ - [ ] Code reviewed
27
+ - [ ] Documentation updated (if necessary)
28
+ - [ ] Unit tests added (if applicable)
29
+
30
+ ## Additional Notes
31
+
32
+ [Add any additional notes or context for the reviewer(s).]