sabazo commited on
Commit
1e3068c
1 Parent(s): 799cabe

added project templates

Browse files

feature request, issue and pr templates

.github/feature_request.md ADDED
@@ -0,0 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ name: Feature request
3
+ about: Suggest an idea for this project
4
+ title: ''
5
+ labels: ''
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ **Is your feature request related to a problem? Please describe.**
11
+ A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12
+
13
+ **Describe the solution you'd like**
14
+ A clear and concise description of what you want to happen.
15
+
16
+ **Describe alternatives you've considered**
17
+ A clear and concise description of any alternative solutions or features you've considered.
18
+
19
+ **Additional context**
20
+ Add any other context or screenshots about the feature request here.
.github/issue_template.md ADDED
@@ -0,0 +1,34 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Issue Template
2
+
3
+ ## Description
4
+ Please provide a clear and concise description of the issue. Include what you expected to happen versus what actually happened. If the issue is related to retrieval results or generative outputs, specify the discrepancies.
5
+
6
+ ## Steps to Reproduce
7
+ 1. Detail the exact steps to reproduce the problem. Include any specific inputs given to the system.
8
+ 2.
9
+ 3.
10
+ (Continue as needed)
11
+
12
+ ## Expected vs. Actual Results
13
+ - **Expected Results**: Describe what you expected to happen.
14
+ - **Actual Results**: Detail what actually happened, including any unexpected outputs or errors.
15
+
16
+ ## Environment
17
+ - Application version:
18
+ - LLM model version:
19
+ - RAG component (if applicable):
20
+ - OS:
21
+ - Additional tools/libraries:
22
+
23
+ ## Query or Input Details
24
+ - **Input Query/Text**: Provide the exact text or input given to the system.
25
+ - **Retrieval Source(s)**: Specify the datasets or sources queried by the RAG component, if relevant.
26
+
27
+ ## Logs and Error Messages
28
+ Please include any relevant logs, error messages, or stack traces that could help diagnose the issue.
29
+
30
+ ## Screenshots
31
+ If applicable, add screenshots to help explain the issue, especially if it involves UI elements.
32
+
33
+ ## Additional Context
34
+ Add any other context about the problem here, such as specific configurations of the LLM or RAG components that might be relevant.
.github/pull_request_template.md ADDED
@@ -0,0 +1,28 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Pull Request Template
2
+
3
+ ## Description
4
+ Please include a brief description of the changes introduced by this PR.
5
+
6
+ ## Related Issue(s)
7
+ - If this PR addresses a particular issue, please reference it here using GitHub's linking syntax, e.g., "Fixes #123".
8
+ - If there's no related issue, briefly explain the motivation behind these changes.
9
+
10
+ ## Changes Made
11
+ Please provide a list of the changes made in this PR.
12
+
13
+ ## Screenshots (if applicable)
14
+ If the changes include UI updates or visual changes, please attach relevant screenshots here.
15
+
16
+ ## Checklist
17
+ - [ ] I have tested my changes locally and ensured that they work as expected.
18
+ - [ ] I have updated the documentation (if applicable).
19
+ - [ ] My code follows the project's coding conventions and style guidelines.
20
+ - [ ] I have added appropriate test cases (if applicable).
21
+ - [ ] I have reviewed my own code to ensure its quality.
22
+
23
+ ## Additional Notes
24
+ Add any additional notes or context about this PR here.
25
+
26
+ ## Reviewer(s)
27
+ - @reviewer1
28
+ - @reviewer2