sabazo commited on
Commit
27b2f1a
1 Parent(s): 58bd64f

Create issue_template.md

Browse files
.github/ISSUE_TEMPLATE/issue_template.md ADDED
@@ -0,0 +1,34 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Issue Template for LLM + RAG Applications
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.