From 171c2019ebc72e67e55fbc4225c0e15930919f23 Mon Sep 17 00:00:00 2001 From: Joe Licata Date: Sun, 28 Dec 2025 05:01:50 +0000 Subject: [PATCH] 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. --- .github/ISSUE_TEMPLATE/bug_report.md | 41 +++++++++++++++-------- .github/ISSUE_TEMPLATE/feature_request.md | 18 ++++++---- .github/workflows/docker-publish.yml | 6 ++++ 3 files changed, 44 insertions(+), 21 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 8bdf12a..e824e64 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,32 +1,45 @@ --- -name: Bug report -about: Create a report to help us improve +name: Bug Report +about: Report a bug or unexpected behavior title: "" -labels: bug, needs-triage +labels: bug assignees: "" --- -**Describe the bug** +## Description + A clear and concise description of what the bug is. -**To Reproduce** -Steps to reproduce the behavior: +## Steps to Reproduce 1. Go to '...' 2. Click on '...' -3. Scroll down to '...' +3. Execute '...' 4. See error -**Expected behavior** +## Expected Behavior + A clear and concise description of what you expected to happen. -**Screenshots** -If applicable, add screenshots to help explain your problem. +## Actual Behavior + +A clear and concise description of what actually happened. + +## Environment + +- OS: [e.g., Ubuntu 22.04, Windows 11, macOS 14] +- Python Version: [e.g., 3.11.5] +- Docker Version: [e.g., 24.0.7] +- Browser (if applicable): [e.g., Chrome 120, Firefox 121] + +## Logs/Screenshots + +If applicable, add logs or screenshots to help explain your problem. -**Environment (please complete the following information):** +``` +Paste relevant logs here +``` -- OS: [e.g. Ubuntu 22.04] -- Version [e.g. 1.0.0] +## Additional Context -**Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 52d4b02..9f597ca 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,19 +1,23 @@ --- -name: Feature request -about: Suggest an idea for this project +name: Feature Request +about: Suggest a new feature or enhancement title: "" -labels: enhancement, needs-triage +labels: enhancement assignees: "" --- -**Is your feature request related to a problem? Please describe.** +## Problem Description + A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -**Describe the solution you'd like** +## Proposed Solution + A clear and concise description of what you want to happen. -**Describe alternatives you've considered** +## Alternatives Considered + A clear and concise description of any alternative solutions or features you've considered. -**Additional context** +## Additional Context + Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml index 89a4cb2..81f62a1 100644 --- a/.github/workflows/docker-publish.yml +++ b/.github/workflows/docker-publish.yml @@ -4,6 +4,12 @@ on: push: branches: ["main", "dev"] tags: ["v*.*.*"] + paths: + - 'Dockerfile' + - 'src/**' + - 'requirements.txt' + - 'pyproject.toml' + - '.github/workflows/docker-publish.yml' workflow_dispatch: env: