Standardize .github configuration - #32
Conversation
|
👋 Hello @glenn-jocher, thank you for submitting a
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
left a comment
There was a problem hiding this comment.
🔍 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:32On 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 ashttps://www.naturalearthdata.com/http//www.naturalearthdata.com/download/10m/cultural/ne_10m_admin_0_countries.zipinmapping/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 |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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.
UltralyticsAssistant
left a comment
There was a problem hiding this comment.
🔍 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.
|
🎉 PR #32 has been merged—thank you, @glenn-jocher!
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. |
Aligns
.github/with the current Ultralytics repository standard: enables the Lychee broken-link check informat.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
links: truein.github/workflows/format.yml, activating Lychee broken-link checks..github/ISSUE_TEMPLATE/config.ymlwith blank issues enabled and links to the README, Ultralytics Community Forum, Discord, and Reddit.🎯 Purpose & Impact