Skip to content

Standardize .github configuration - #32

Merged
glenn-jocher merged 2 commits into
mainfrom
github-standardize
Aug 15, 2026
Merged

Standardize .github configuration#32
glenn-jocher merged 2 commits into
mainfrom
github-standardize

Conversation

@glenn-jocher

@glenn-jocher glenn-jocher commented Aug 15, 2026

Copy link
Copy Markdown
Member

Aligns .github/ with the current Ultralytics repository standard: enables the Lychee broken-link check in format.yml (links: true) and adds the standard issue templates (bug report, feature request, question, config) tailored to this repository.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Standardized the repository’s GitHub configuration by enabling Lychee link checking and adding structured issue templates for bugs, feature requests, and questions.

📊 Key Changes

  • Enabled links: true in .github/workflows/format.yml, activating Lychee broken-link checks.
  • Added a bug report form tailored to the shared MATLAB functions, including component selection, environment details, and a minimal reproducible example.
  • Added feature request and question forms with search-before-submitting prompts and relevant repository context.
  • Added .github/ISSUE_TEMPLATE/config.yml with blank issues enabled and links to the README, Ultralytics Community Forum, Discord, and Reddit.

🎯 Purpose & Impact

  • GitHub issue submission now guides users toward structured bug, feature, and question reports with repository-specific fields and labels.
  • The formatting workflow now checks links for breakage.

@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/functions-matlab 🚀 PR! This automated message confirms your contribution was received, and an Ultralytics engineer will assist with the review. To ensure a seamless integration of your work, please review the following checklist:

  • Define a Purpose: Clearly explain the purpose of your fix or feature in your PR description, and link to any relevant issues. Ensure your commit messages are clear, concise, and adhere to the project's conventions.
  • Synchronize with Source: Confirm your PR is synchronized with the ultralytics/functions-matlab main branch. If it's behind, update it by clicking the 'Update branch' button or by running git pull and git merge main locally.
  • Ensure CI Checks Pass: Verify all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address the issues.
  • Update Documentation: Update the relevant documentation for any new or modified features.
  • Add Tests: If applicable, include or update tests to cover your changes, and confirm that all tests are passing.
  • Sign the CLA: Please ensure you have signed our Contributor License Agreement if this is your first Ultralytics PR by writing "I have read the CLA Document and I sign the CLA" in a new message.
  • Minimize Changes: Limit your changes to the minimum necessary for your bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." — Bruce Lee

For more guidance, please refer to our Contributing Guide. Don't hesitate to leave a comment if you have any questions. Thank you for contributing to Ultralytics! 🚀

@UltralyticsAssistant UltralyticsAssistant added the devops GitHub Devops or MLops label Aug 15, 2026

@UltralyticsAssistant UltralyticsAssistant left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🔍 PR Review

Made with ❤️ by Ultralytics Actions

Found one blocking CI regression: enabling the fail-closed link checker exposes malformed links in the existing HTML corpus. The workflow change should be paired with link cleanup or a narrowly scoped exclusion.

💬 Posted 1 inline comment
  • ⚠️ HIGH .github/workflows/format.yml:32 On every non-closed PR, the shared action runs Lychee against all Markdown and HTML files and fails the job on any unaccepted response. This repository already contains malformed HTTPS download links such as https://www.naturalearthdata.com/http//www.naturalearthdata.com/download/10m/cultural/ne_10m_admin_0_countries.zip in mapping/ne_10m_admin_0_countries/ne_10m_admin_0_countries.README.html; enabling this gate will make otherwise unrelated PRs fail until the existing HTML links are correc…

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.

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.

@glenn-jocher glenn-jocher changed the title Enable link checks in Ultralytics Actions Standardize .github configuration Aug 15, 2026

@UltralyticsAssistant UltralyticsAssistant left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🔍 PR Review 2

Made with ❤️ by Ultralytics Actions

Since review 1, the prior Lychee concern has been settled by the reported 0-error workflow run. The current issue templates, configuration, and link-checker change introduce no additional concrete regressions. LGTM.

@glenn-jocher
glenn-jocher merged commit 85fe8f9 into main Aug 15, 2026
6 checks passed
@glenn-jocher
glenn-jocher deleted the github-standardize branch August 15, 2026 17:30
@UltralyticsAssistant

Copy link
Copy Markdown
Member

🎉 PR #32 has been merged—thank you, @glenn-jocher!

“Alone we can do so little; together we can do so much.” — Helen Keller

This contribution strengthens the repository’s GitHub workflow by enabling Lychee link checks and adding structured templates for bug reports, feature requests, and questions, helping guide contributors toward clear, repository-specific submissions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

devops GitHub Devops or MLops

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants