Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 86 additions & 0 deletions .github/ISSUE_TEMPLATE/01-report-bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
name: 'Report a bug'
description: 'Use this template to report Neo4j GraphRAG related issues'
title: '[BUG]: <short description of the issue>'
labels:
- bug
body:
- type: checkboxes
id: preliminary-checks
attributes:
label: Before You Report a Bug, Please Confirm You Have Done The Following...
description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you!
options:
- label: I have updated to the latest version of the packages.
required: true
- 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.
required: true
- type: input
id: neo4j-graphrag-python-version
attributes:
label: neo4j-graphrag-python's version
description: |
Please provide your neo4j-graphrag-python version with calling the command `python -c "import neo4j_graphrag; print(neo4j_graphrag.__version__)"` in your terminal
placeholder: e.g. 1.10.0
validations:
required: true
- type: input
id: python-version
attributes:
label: Python version
description: |
Please provide your python programming language's version with calling `python --version` in your terminal
placeholder: e.g. 3.11.13
validations:
required: true
- type: input
id: os
attributes:
label: Operating System
description: |
Please provide your operation system's details
placeholder: e.g. Windows 10 or Ubuntu 20.04
validations:
required: false
- type: textarea
id: dependencies
attributes:
label: Dependencies
description: |
Please provide python dependencies with calling `pip freeze` in your terminal (or `poetry show` if you are using Poetry).
validations:
required: true
- type: textarea
id: repro-code
attributes:
label: Reproducible example
description: A ***minimal*** code sample which reproduces the issue
render: Python
validations:
required: true
- type: textarea
id: exception-message
attributes:
label: Relevant Log Output
description: Please share the exception message from your terminal if your program is failing
validations:
required: false
- type: textarea
id: expected
attributes:
label: Expected Result
description: What did you expect to happen?
validations:
required: false
- type: textarea
id: actual
attributes:
label: What happened instead?
description: What actually happened?
validations:
required: false
- type: textarea
id: additional
attributes:
label: Additional Info
description: |
Any additional info you'd like to provide.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/02-request-feature.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: 'Request a New Feature'
description: 'Use this template to propose a new feature'
title: '[FEATURE]: <a short description of my proposal>'
labels:
- 'enhancement'
body:
- type: textarea
id: description
attributes:
label: Description
description: Explain what your proposed feature would do and why this is useful.
validations:
required: true
- type: textarea
id: additional
attributes:
label: Additional Info
description: Any additional info you'd like to provide.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/03-documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: 'Documentation'
description: 'Use this template to add or improve docs'
title: '[DOC]: <a short description of my proposal>'
labels:
- documentation
body:
- type: textarea
attributes:
label: Suggested Changes
description: What would you like to see happen in the docs?
validations:
required: true
- type: textarea
id: additional
attributes:
label: Additional Info
description: |
Any additional info you'd like to provide.
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/04-question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: 'Question'
description: 'Use this template to ask a question'
title: '[QUESTION]: <a short description of my question>'
labels:
- question
body:
- type: textarea
attributes:
label: Question
description: What is your question?
validations:
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
Loading