|
| 1 | +--- |
| 2 | +name: Bug report |
| 3 | +about: Report a reproducible bug or unexpected behavior. |
| 4 | +title: "[Bug]: Clear and concise description of the bug" |
| 5 | +labels: bug, needs-triage |
| 6 | +assignees: '' |
| 7 | + |
| 8 | +--- |
| 9 | + |
| 10 | +## Bug Description |
| 11 | + |
| 12 | +Clearly and concisely describe the bug you've encountered. What is the unexpected behavior? What did you expect to happen instead? |
| 13 | + |
| 14 | +## Steps to Reproduce |
| 15 | + |
| 16 | +Provide a clear, step-by-step procedure to reproduce the bug. This is crucial for us to understand and fix the issue. |
| 17 | + |
| 18 | +1. Go to '...' |
| 19 | +2. Click on '....' |
| 20 | +3. Scroll down to '....' |
| 21 | +4. See error '....' |
| 22 | + |
| 23 | +## Code or Configuration Example |
| 24 | + |
| 25 | +If the bug involves code or configuration, please provide a minimal, reproducible example that demonstrates the issue. This should be the smallest amount of code/config necessary to trigger the bug. |
| 26 | + |
| 27 | +```python |
| 28 | +# Example of bug-inducing code (if relevant) |
| 29 | +import my_library |
| 30 | + |
| 31 | +# Setup or initialization |
| 32 | +config = { |
| 33 | + "setting_a": "value", |
| 34 | + "setting_b": 123 |
| 35 | +} |
| 36 | +processor = my_library.Processor(**config) |
| 37 | + |
| 38 | +# Action that triggers the bug |
| 39 | +try: |
| 40 | + processor.process_data(invalid_data) |
| 41 | +except Exception as e: |
| 42 | + print(f"Error: {e}") |
| 43 | +``` |
| 44 | + |
| 45 | +## Error Message / Stack Trace |
| 46 | + |
| 47 | +If an error message or stack trace was produced, please include it here. Use code blocks for better readability. |
| 48 | + |
| 49 | +```text |
| 50 | +# Example Error Message/Stack Trace |
| 51 | +Traceback (most recent call last): |
| 52 | + File "<stdin>", line 7, in <module> |
| 53 | + processor.process_data(invalid_data) |
| 54 | + File "/path/to/my_library/processor.py", line 42, in process_data |
| 55 | + raise ValueError("Invalid data provided") |
| 56 | +ValueError: Invalid data provided |
| 57 | +``` |
| 58 | + |
| 59 | +## Screenshots / Videos |
| 60 | + |
| 61 | +If applicable, add screenshots to help explain the problem. You can drag and drop images directly into the issue description. |
| 62 | + |
| 63 | +## Expected Behavior |
| 64 | + |
| 65 | +Describe what you expected to happen when following the reproduction steps. |
| 66 | + |
| 67 | +## Actual Behavior |
| 68 | + |
| 69 | +Describe what actually happened, including any unexpected output or results. |
| 70 | + |
| 71 | +## Environment |
| 72 | + |
| 73 | +Please provide details about your environment. This helps us reproduce the issue. |
| 74 | + |
| 75 | +* **Operating System:** |
| 76 | +* **Python Version:** |
| 77 | +* **Project Version:** |
| 78 | +* **Relevant Dependencies:** |
| 79 | + |
| 80 | +## Checklist |
| 81 | + |
| 82 | +* [ ] I have searched existing issues to ensure this bug hasn't already been reported. |
| 83 | +* [ ] I have provided clear steps to reproduce the bug. |
| 84 | +* [ ] I have provided a minimal, reproducible code example (if applicable). |
| 85 | +* [ ] I have included any relevant error messages or stack traces. |
| 86 | +* [ ] I have described the expected and actual behavior. |
0 commit comments