diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 8e93af3..7b51e5d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -10,7 +10,15 @@ assignees: '' **Describe the bug** A clear and concise description of what the bug is. -**To Reproduce** +**Complete Minimal Reproducible Example** +To help us identify and fix the bug more efficiently, please provide a *complete minimal reproducible example* (MRE) that demonstrates the issue. This includes the smallest amount of code that reproduces the bug, along with any necessary configuration or dependencies. Follow these guidelines for your MRE: + +- **Isolate the Problem**: Trim down your code to the bare minimum that still triggers the bug. +- **Include Environment and Dependencies**: Mention any specific setup, versions, and dependencies needed. +- **Step-by-Step Instructions**: Ensure you include clear instructions to run your example and replicate the issue. + +**Note**: Creating a minimal example might take extra effort, but it's incredibly valuable for quickly resolving your issue. Reports with clear, concise, and complete examples are addressed more promptly. + Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' @@ -24,10 +32,10 @@ A clear and concise description of what you expected to happen. If applicable, add screenshots to help explain your problem. **Tech Stack (please complete the following information):** - - weaviate server version: - - weaviate modules enabled e.g. txt2vec-openai: - - langchain-weaviate version: - - langchain version: +- weaviate server version: +- weaviate modules enabled e.g. txt2vec-openai: +- langchain-weaviate version: +- langchain version: **Additional context** Add any other context about the problem here.