Skip to content

Commit bc6fb45

Browse files
committed
issue templates added
1 parent 4541de2 commit bc6fb45

File tree

5 files changed

+135
-0
lines changed

5 files changed

+135
-0
lines changed
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: 'Report a bug'
2+
description: 'Use this template to report Neo4j GraphRAG related issues'
3+
title: '[BUG]: <short description of the issue>'
4+
labels:
5+
- bug
6+
body:
7+
- type: checkboxes
8+
id: preliminary-checks
9+
attributes:
10+
label: Before You Report a Bug, Please Confirm You Have Done The Following...
11+
description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!
12+
options:
13+
- label: I have updated to the latest version of the packages.
14+
required: true
15+
- label: I have searched for both [existing issues](https://github.com/neo4j/neo4j-graphrag-python/issues) and [closed issues](https://github.com/neo4j/neo4j-graphrag-python/issues?q=is%3Aissue+is%3Aclosed) and found none that matched my issue.
16+
required: true
17+
- type: input
18+
id: neo4j-graphrag-python-version
19+
attributes:
20+
label: neo4j-graphrag-python's version
21+
description: |
22+
Please provide your neo4j-graphrag-python version with calling the command `python -c "import neo4j_graphrag; print(neo4j_graphrag.__version__)"` in your terminal
23+
placeholder: e.g. 1.10.0
24+
validations:
25+
required: true
26+
- type: input
27+
id: python-version
28+
attributes:
29+
label: Python version
30+
description: |
31+
Please provide your python programming language's version with calling `python --version` in your terminal
32+
placeholder: e.g. 3.11.13
33+
validations:
34+
required: true
35+
- type: input
36+
id: os
37+
attributes:
38+
label: Operating System
39+
description: |
40+
Please provide your operation system's details
41+
placeholder: e.g. Windows 10 or Ubuntu 20.04
42+
validations:
43+
required: false
44+
- type: textarea
45+
id: dependencies
46+
attributes:
47+
label: Dependencies
48+
description: |
49+
Please provide python dependencies with calling `pip freeze` in your terminal (or `poetry show` if you are using Poetry).
50+
validations:
51+
required: true
52+
- type: textarea
53+
id: repro-code
54+
attributes:
55+
label: Reproducible example
56+
description: A ***minimal*** code sample which reproduces the issue
57+
render: Python
58+
validations:
59+
required: true
60+
- type: textarea
61+
id: exception-message
62+
attributes:
63+
label: Relevant Log Output
64+
description: Please share the exception message from your terminal if your program is failing
65+
validations:
66+
required: false
67+
- type: textarea
68+
id: expected
69+
attributes:
70+
label: Expected Result
71+
description: What did you expect to happen?
72+
validations:
73+
required: false
74+
- type: textarea
75+
id: actual
76+
attributes:
77+
label: What happened instead?
78+
description: What actually happened?
79+
validations:
80+
required: false
81+
- type: textarea
82+
id: additional
83+
attributes:
84+
label: Additional Info
85+
description: |
86+
Any additional info you'd like to provide.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: 'Request a New Feature'
2+
description: 'Use this template to propose a new feature'
3+
title: '[FEATURE]: <a short description of my proposal>'
4+
labels:
5+
- 'enhancement'
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: Description
11+
description: Explain what your proposed feature would do and why this is useful.
12+
validations:
13+
required: true
14+
- type: textarea
15+
id: additional
16+
attributes:
17+
label: Additional Info
18+
description: Any additional info you'd like to provide.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: 'Documentation'
2+
description: 'Use this template to add or improve docs'
3+
title: '[DOC]: <a short description of my proposal>'
4+
labels:
5+
- documentation
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Suggested Changes
10+
description: What would you like to see happen in the docs?
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: additional
15+
attributes:
16+
label: Additional Info
17+
description: |
18+
Any additional info you'd like to provide.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: 'Question'
2+
description: 'Use this template to ask a question'
3+
title: '[QUESTION]: <a short description of my question>'
4+
labels:
5+
- question
6+
body:
7+
- type: textarea
8+
attributes:
9+
label: Question
10+
description: What is your question?
11+
validations:
12+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

0 commit comments

Comments
 (0)