Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 94 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license

name: 🐛 Bug Report
# title: " "
description: Problems with the Ultralytics shared MATLAB functions
labels: [bug, triage]
type: "bug"
body:
- type: markdown
attributes:
value: |
Thank you for submitting an Ultralytics 🐛 Bug Report!

- type: checkboxes
attributes:
label: Search before asking
description: >
Please search the [issues](https://github.com/ultralytics/functions-matlab/issues) to see if a similar bug report already exists.
options:
- label: >
I have searched the Ultralytics [issues](https://github.com/ultralytics/functions-matlab/issues) and found no similar bug report.
required: true

- type: dropdown
attributes:
label: Ultralytics Component
description: |
Please select the component where you found the bug.
multiple: true
options:
- "Geometry"
- "Machine learning"
- "Data analysis"
- "Visualization"
- "MEX/C++ build"
- "Documentation"
- "Other"
validations:
required: false

- type: textarea
attributes:
label: Bug
description: Please provide as much information as possible. Copy and paste console output and error messages including the _full_ traceback. 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) to format text, code and logs. If necessary, include screenshots for visual elements only. Providing detailed information will help us resolve the issue more efficiently.
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: Environment
description: Please provide your system information to help us diagnose the problem.
placeholder: |
Please include:
- OS (e.g., Ubuntu 22.04, macOS 14.5, Windows 11)
- MATLAB version (e.g., R2024b, run `version`)
- Required toolboxes (run `ver`)
- Any relevant environment details

Example:
```
OS: macOS-14.5
MATLAB: R2024b
Toolboxes: Image Processing Toolbox, Statistics and Machine Learning Toolbox
```
validations:
required: true

- type: textarea
attributes:
label: Minimal Reproducible Example
description: >
When asking a question, people will be better able to provide help if you provide code that they can easily understand and use to **reproduce** the problem. This is referred to by community members as creating a [minimal reproducible example](https://docs.ultralytics.com/help/minimum-reproducible-example/).
placeholder: |
```matlab
% 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/functions-matlab/pulls) (PR) to help improve Ultralytics software 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!
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license

blank_issues_enabled: true
contact_links:
- name: 📄 README
url: https://github.com/ultralytics/functions-matlab#readme
about: Repository overview and usage
- 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
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license

name: 🚀 Feature Request
description: Suggest a functions-matlab idea
# title: " "
labels: [enhancement]
type: "feature"
body:
- type: markdown
attributes:
value: |
Thank you for submitting an Ultralytics 🚀 Feature Request!

- type: checkboxes
attributes:
label: Search before asking
description: >
Please search the [issues](https://github.com/ultralytics/functions-matlab/issues) to see if a similar feature request already exists.
options:
- label: >
I have searched the Ultralytics [issues](https://github.com/ultralytics/functions-matlab/issues) and found no similar feature requests.
required: true

- type: textarea
attributes:
label: Description
description: A short description of your feature.
placeholder: |
What new feature would you like to see in the Ultralytics shared MATLAB functions?
validations:
required: true

- type: textarea
attributes:
label: Use case
description: |
Describe the use case of your feature request. It will help us understand and prioritize the feature request.
placeholder: |
How would this feature be used, and who would use it?

- 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/functions-matlab/pulls) (PR) to help improve Ultralytics software 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!
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license

name: ❓ Question
description: Ask a functions-matlab question
# title: " "
labels: [question]
body:
- type: markdown
attributes:
value: |
Thank you for asking an Ultralytics ❓ Question!

- type: checkboxes
attributes:
label: Search before asking
description: >
Please search the [issues](https://github.com/ultralytics/functions-matlab/issues) and [discussions](https://github.com/orgs/ultralytics/discussions) to see if a similar question already exists.
options:
- label: >
I have searched the Ultralytics [issues](https://github.com/ultralytics/functions-matlab/issues) and [discussions](https://github.com/orgs/ultralytics/discussions) and found no similar questions.
required: true

- type: textarea
attributes:
label: Question
description: What is your question? Please provide as much information as possible. Include detailed code examples to reproduce the problem and describe the context in which the issue occurs. Format your text and code using [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 and readability. Following these guidelines will help us assist you more effectively.
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: Additional
description: Anything else you would like to share?
2 changes: 1 addition & 1 deletion .github/workflows/format.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
python: false # No Python files in this repository
prettier: true # Format YAML, JSON, Markdown, CSS
spelling: true # Check spelling with codespell
links: false # Check broken links with Lychee
links: true # Check broken links with Lychee

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified on this PR's own Ultralytics Actions run (https://github.com/ultralytics/functions-matlab/actions/runs/31895596194): the Broken Link Checker step completed with 0 errors, so this does not regress CI. Local image references are outside Lychee's checked scope in this configuration.

summary: true # Generate AI-powered PR summaries
openai_api_key: ${{ secrets.OPENAI_API_KEY }} # Powers PR summaries, labels and comments
brave_api_key: ${{ secrets.BRAVE_API_KEY }} # Used for broken link resolution
Loading