Skip to content

Commit 523d71c

Browse files
committed
Add tailored bug_report.md template for CodeEntropy bugs
1 parent 780b326 commit 523d71c

1 file changed

Lines changed: 40 additions & 17 deletions

File tree

Lines changed: 40 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,54 @@
1+
12
---
23
name: Bug report
34
about: Create a report to help us improve
45
title: ''
56
labels: bug
67
assignees: ''
8+
---
9+
10+
# Bug Report
11+
12+
**Describe the bug**
13+
<!-- A clear and concise description of the issue. -->
714

815
---
916

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
17+
## To Reproduce
18+
<!-- Provide a minimal YAML configuration and the exact CLI command that reproduces the issue. -->
1219

13-
**To Reproduce**
14-
Steps to reproduce the behavior:
15-
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
18-
4. See error
20+
### YAML configuration
21+
<!-- Paste the YAML file or the smallest excerpt that reproduces the issue.
22+
Remove unrelated fields to make it minimal. -->
23+
```yaml
1924

20-
**Expected behavior**
21-
A clear and concise description of what you expected to happen.
25+
```
26+
27+
### CLI command used
28+
<!-- Write the exact command used, for example: -->
29+
```bash
30+
```
31+
32+
### Actual output
33+
<!-- Paste the output, logs, or error messages here. -->
34+
35+
Describe what you expected to see instead.
36+
---
2237

23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
38+
## Environment and Versions
39+
40+
- CodeEntropy Version:
41+
- OS: e.g., Ubuntu 22.04
42+
- Python Version: e.g.,
43+
44+
---
45+
46+
## Screenshots or Logs
47+
48+
Attach any relevant screenshots, logs, or stack traces.
49+
50+
---
2551

26-
**Operating System and Version (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Version [e.g. 22]
52+
## Additional Context
2953

30-
**Additional context**
31-
Add any other context about the problem here.
54+
Include anything else that might help reproduce or understand the bug, such as changes from a previously working version.

0 commit comments

Comments
 (0)