From c4640a4c3c5e65220b010328f177d9c8c14bdbeb Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Sun, 16 Nov 2025 17:09:01 +0100 Subject: [PATCH] Add Issue templates (#658) Signed-off-by: Glenn Jocher Co-authored-by: Ultralytics Assistant <135830346+UltralyticsAssistant@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug-report.yml | 113 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 16 +++ .github/ISSUE_TEMPLATE/feature-request.yml | 80 +++++++++++++++ .github/ISSUE_TEMPLATE/question.yml | 61 +++++++++++ 4 files changed, 270 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..503db1f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,113 @@ +# Ultralytics πŸš€ AGPL-3.0 License - https://ultralytics.com/license + +name: πŸ› Bug Report +# title: " " +description: Problems with Ultralytics Actions workflows, standalone actions, or the Python package +labels: [bug] +type: "bug" +body: + - type: markdown + attributes: + value: | + Thank you for submitting an Ultralytics Actions πŸ› Bug Report! Read the [Ultralytics Actions README](https://github.com/ultralytics/actions#readme) first to confirm the expected behavior and configuration for each action. + + - type: checkboxes + attributes: + label: Search before asking + description: > + Please read the [Ultralytics Actions README](https://github.com/ultralytics/actions#readme), search the Ultralytics [Docs](https://docs.ultralytics.com/), and review existing [issues](https://github.com/ultralytics/actions/issues) to see if a similar bug report already exists. + options: + - label: > + I have reviewed the Ultralytics Actions README and searched the [issues](https://github.com/ultralytics/actions/issues) with no similar bug report. + required: true + + - type: dropdown + attributes: + label: Ultralytics Actions area + description: | + Please select the part of this repository that is affected. + multiple: true + options: + - "Ultralytics Actions workflow (ultralytics/actions@main)" + - "Retry Action" + - "Cleanup Disk Action" + - "Scan PRs Action" + - "Python package (`ultralytics-actions`)" + - "Repository documentation / README" + - "Other" + validations: + required: false + + - type: textarea + attributes: + label: Workflow or command context + description: > + Share the relevant GitHub workflow snippet, CLI command, or Python API usage (see README sections: Ultralytics Actions, Standalone Actions, and Python Package). Describe what you expected to happen and what happened instead. + placeholder: | + ```yaml + - name: Run Ultralytics Actions + uses: ultralytics/actions@main + with: + python: true + summary: true + ``` + validations: + required: true + + - type: textarea + attributes: + label: Bug + description: Include actionable details such as failing job links, action version (`@main`, commit SHA, or package version), logs, screenshots, and any configuration overrides. Use [Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) for formatting. + placeholder: | + πŸ’‘ ProTip! Include GitHub Actions URLs, console logs, stack traces, and the outcome vs. expectation so we can reproduce quickly. + validations: + required: true + + - type: textarea + attributes: + label: Environment + description: Please provide your runner/system information to help us diagnose the problem. + placeholder: | + Please include: + - Runner OS (e.g., ubuntu-latest, macos-13, self-hosted) + - Workflow trigger (push, PR, issue) or CLI environment + - `ultralytics-actions` version (Action ref or pip version) + - Python version (if using the package) + - Any other tooling versions (Ruff, Prettier, swift-format, etc.) + + Example: + ``` + OS: macOS-13.5.2 + Python: 3.11.2 + Action ref: ultralytics/actions@main + Runner: ubuntu-latest + Workflow: .github/workflows/ultralytics-actions.yml + ``` + validations: + required: true + + - type: textarea + attributes: + label: Minimal Reproducible Example + description: > + Provide the smallest workflow snippet, command invocation, or Python example that reproduces the bug using the guidance in the README. See [minimal reproducible example](https://docs.ultralytics.com/help/minimum-reproducible-example/). + placeholder: | + ```python + # Code to reproduce your issue here + ``` + validations: + required: true + + - type: textarea + attributes: + label: Additional + description: Anything else you would like to share? + + - type: checkboxes + attributes: + label: Are you willing to submit a PR? + description: > + (Optional) We encourage you to submit a [Pull Request](https://github.com/ultralytics/actions/pulls) (PR) to help improve Ultralytics Actions for everyone, especially if you have a good understanding of how to implement a fix or feature. + See the Ultralytics [Contributing Guide](https://docs.ultralytics.com/help/contributing/) to get started. + options: + - label: Yes I'd like to help by submitting a PR! diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..e57e190 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,16 @@ +# Ultralytics πŸš€ AGPL-3.0 License - https://ultralytics.com/license + +blank_issues_enabled: true +contact_links: + - name: πŸ“„ Docs + url: https://docs.ultralytics.com/ + about: Full Ultralytics Documentation + - name: πŸ’¬ Forum + url: https://community.ultralytics.com/ + about: Ask on Ultralytics Community Forum + - name: 🎧 Discord + url: https://ultralytics.com/discord + about: Ask on Ultralytics Discord + - name: ⌨️ Reddit + url: https://reddit.com/r/ultralytics + about: Ask on Ultralytics Subreddit diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..90d60b7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,80 @@ +# Ultralytics πŸš€ AGPL-3.0 License - https://ultralytics.com/license + +name: πŸš€ Feature Request +description: Suggest an Ultralytics Actions improvement +# title: " " +labels: [enhancement] +type: "feature" +body: + - type: markdown + attributes: + value: | + Thank you for submitting an Ultralytics Actions πŸš€ Feature Request! Review the [Ultralytics Actions README](https://github.com/ultralytics/actions#readme) to ensure the requested functionality does not already exist. + + - type: checkboxes + attributes: + label: Search before asking + description: > + Please read the [Ultralytics Actions README](https://github.com/ultralytics/actions#readme), browse the Ultralytics [Docs](https://docs.ultralytics.com/), and search existing [issues](https://github.com/ultralytics/actions/issues) to see if a similar feature request already exists. + options: + - label: > + I have reviewed the Ultralytics Actions README and searched the [issues](https://github.com/ultralytics/actions/issues) with no similar feature requests. + required: true + + - type: dropdown + attributes: + label: Ultralytics Actions area + description: | + Select the part of the repository this feature targets. + multiple: true + options: + - "Ultralytics Actions workflow (ultralytics/actions@main)" + - "Retry Action" + - "Cleanup Disk Action" + - "Scan PRs Action" + - "Python package (`ultralytics-actions`)" + - "Repository documentation / README" + - "Other" + + - type: textarea + attributes: + label: Description + description: Describe the feature you would like to see, including the current limitation or pain point. + placeholder: | + What new capability should Ultralytics Actions provide? + validations: + required: true + + - type: textarea + attributes: + label: Use case + description: | + Describe the workflow, GitHub Action job, or Python automation that would benefit. Link to README sections or workflows this feature builds upon. + placeholder: | + How would this feature be used, and who would use it? + + - type: textarea + attributes: + label: Proposed solution + description: Outline your ideal implementation details. Include workflow snippets, flags, or API changes referencing README terminology. + placeholder: | + ```yaml + - uses: ultralytics/actions@main + with: + summary: true + : true + ``` + + - type: textarea + attributes: + label: Additional + description: Anything else you would like to share? + + - type: checkboxes + attributes: + label: Are you willing to submit a PR? + description: > + (Optional) We encourage you to submit a [Pull Request](https://github.com/ultralytics/actions/pulls) (PR) to help improve Ultralytics Actions for everyone, especially if you have a good understanding of how to implement a fix or feature. + See the Ultralytics [Contributing Guide](https://docs.ultralytics.com/help/contributing/) to get started. + options: + - label: Yes I'd like to help by submitting a PR! diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..3bb3370 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,61 @@ +# Ultralytics πŸš€ AGPL-3.0 License - https://ultralytics.com/license + +name: ❓ Question +description: Ask an Ultralytics Actions question +# title: " " +labels: [question] +body: + - type: markdown + attributes: + value: | + Thank you for asking an Ultralytics Actions ❓ Question! The [README](https://github.com/ultralytics/actions#readme) contains detailed setup steps for the main Action, standalone actions, and the Python packageβ€”please review it before posting. + + - type: checkboxes + attributes: + label: Search before asking + description: > + I have reviewed the README and Docs and searched the Ultralytics [issues](https://github.com/ultralytics/actions/issues) and [discussions](https://github.com/orgs/ultralytics/discussions) with no similar questions. + options: + - label: > + I have reviewed the README and searched the Ultralytics [issues](https://github.com/ultralytics/actions/issues) and [discussions](https://github.com/orgs/ultralytics/discussions) with no similar questions. + required: true + + - type: dropdown + attributes: + label: Ultralytics Actions area + description: Select the area you need help with. + multiple: true + options: + - "Ultralytics Actions workflow (ultralytics/actions@main)" + - "Retry Action" + - "Cleanup Disk Action" + - "Scan PRs Action" + - "Python package (`ultralytics-actions`)" + - "Repository documentation / README" + - "Other" + + - type: textarea + attributes: + label: Question + description: Provide details about what you're trying to accomplish, referencing README sections or workflow snippets where possible. Include the action configuration, command, or Python usage plus any logs. Use [Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) for clarity. + placeholder: | + πŸ’‘ ProTip! Include as much information as possible (logs, tracebacks, screenshots etc.) to receive the most helpful response. + validations: + required: true + + - type: textarea + attributes: + label: Workflow or command context + description: Paste the relevant GitHub workflow step, CLI command, or Python snippet that illustrates your question. + placeholder: | + ```yaml + - uses: ultralytics/actions@main + with: + labels: true + summary: true + ``` + + - type: textarea + attributes: + label: Additional + description: Anything else you would like to share?