Skip to content

Commit 171c201

Browse files
committed
chore: Update issue templates for bug reports and feature requests
- Enhanced the structure and clarity of the bug report and feature request templates. - Added sections for actual behavior, environment details, and logs/screenshots to improve bug reporting. - Updated headings for consistency and better readability.
1 parent 6ef9ce7 commit 171c201

3 files changed

Lines changed: 44 additions & 21 deletions

File tree

Lines changed: 27 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,45 @@
11
---
2-
name: Bug report
3-
about: Create a report to help us improve
2+
name: Bug Report
3+
about: Report a bug or unexpected behavior
44
title: ""
5-
labels: bug, needs-triage
5+
labels: bug
66
assignees: ""
77
---
88

9-
**Describe the bug**
9+
## Description
10+
1011
A clear and concise description of what the bug is.
1112

12-
**To Reproduce**
13-
Steps to reproduce the behavior:
13+
## Steps to Reproduce
1414

1515
1. Go to '...'
1616
2. Click on '...'
17-
3. Scroll down to '...'
17+
3. Execute '...'
1818
4. See error
1919

20-
**Expected behavior**
20+
## Expected Behavior
21+
2122
A clear and concise description of what you expected to happen.
2223

23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
24+
## Actual Behavior
25+
26+
A clear and concise description of what actually happened.
27+
28+
## Environment
29+
30+
- OS: [e.g., Ubuntu 22.04, Windows 11, macOS 14]
31+
- Python Version: [e.g., 3.11.5]
32+
- Docker Version: [e.g., 24.0.7]
33+
- Browser (if applicable): [e.g., Chrome 120, Firefox 121]
34+
35+
## Logs/Screenshots
36+
37+
If applicable, add logs or screenshots to help explain your problem.
2538

26-
**Environment (please complete the following information):**
39+
```
40+
Paste relevant logs here
41+
```
2742

28-
- OS: [e.g. Ubuntu 22.04]
29-
- Version [e.g. 1.0.0]
43+
## Additional Context
3044

31-
**Additional context**
3245
Add any other context about the problem here.
Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,23 @@
11
---
2-
name: Feature request
3-
about: Suggest an idea for this project
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement
44
title: ""
5-
labels: enhancement, needs-triage
5+
labels: enhancement
66
assignees: ""
77
---
88

9-
**Is your feature request related to a problem? Please describe.**
9+
## Problem Description
10+
1011
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1112

12-
**Describe the solution you'd like**
13+
## Proposed Solution
14+
1315
A clear and concise description of what you want to happen.
1416

15-
**Describe alternatives you've considered**
17+
## Alternatives Considered
18+
1619
A clear and concise description of any alternative solutions or features you've considered.
1720

18-
**Additional context**
21+
## Additional Context
22+
1923
Add any other context or screenshots about the feature request here.

.github/workflows/docker-publish.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ on:
44
push:
55
branches: ["main", "dev"]
66
tags: ["v*.*.*"]
7+
paths:
8+
- 'Dockerfile'
9+
- 'src/**'
10+
- 'requirements.txt'
11+
- 'pyproject.toml'
12+
- '.github/workflows/docker-publish.yml'
713
workflow_dispatch:
814

915
env:

0 commit comments

Comments
 (0)