Skip to content

Standardize .github configuration - #26

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

Standardize .github configuration#26
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 checks and adding structured issue templates for bugs, feature requests, questions, and configuration.

📊 Key Changes

  • Enabled broken-link checking in .github/workflows/format.yml with links: true.
  • Added a bug report template tailored to SANDD waveform processing, timing reconstruction, charge reconstruction, and candidate selection.
  • Added feature request and question templates with required search confirmations and structured details.
  • Added issue configuration with links to the README, Ultralytics Community Forum, Discord, and Reddit, while keeping blank issues enabled.

🎯 Purpose & Impact

  • GitHub issue submissions now provide standardized fields and labels for common request types.
  • The formatting workflow now runs Lychee link checks.
  • Existing users can still open blank issues, so there is no restriction on issue creation.

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

Copy link
Copy Markdown
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/sandd 🚀 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/sandd 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 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

Reviewed .github/workflows/format.yml and the repository contents relevant to link checking. The change only enables the existing Lychee link-check option in Ultralytics Actions, with no conflicting configuration or repository links identified. LGTM.

@glenn-jocher glenn-jocher changed the title Enable link checks in Ultralytics Actions Standardize .github configuration Aug 15, 2026
@UltralyticsAssistant
UltralyticsAssistant dismissed their stale review August 15, 2026 17:21

Superseded by new review

@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 the previous review, I also checked the newly added issue forms. The workflow change and issue-form schemas otherwise look sound; one bounded configuration issue remains because triage is referenced but absent from the repository labels. (docs.github.com)

💬 Posted 1 inline comment

name: 🐛 Bug Report
# title: " "
description: Problems with the SANDD waveform processing tools
labels: [bug, triage]

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.

Resolved at the owner: the triage label now exists in this repository (created org-wide, matching the reference templates in ultralytics/sdk which use labels: [bug, triage]). Template left unchanged.

name: 🐛 Bug Report
# title: " "
description: Problems with the SANDD waveform processing tools
labels: [bug, triage]

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.

Resolved at the owner: the triage label now exists in this repository (created org-wide, matching the reference templates in ultralytics/sdk which use labels: [bug, triage]). Template left unchanged.

@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 3

Made with ❤️ by Ultralytics Actions

Since review 2, the earlier triage-label finding was addressed by the owner. I rechecked the Lychee workflow change and all four added issue configuration files; no additional concrete defects remain. LGTM.

@glenn-jocher
glenn-jocher merged commit 813ab0a into main Aug 15, 2026
7 checks passed
@glenn-jocher
glenn-jocher deleted the github-standardize branch August 15, 2026 17:41
@UltralyticsAssistant

Copy link
Copy Markdown
Member

🎉 PR #26 was successfully merged—thank you, @glenn-jocher!

“Great things are done by a series of small things brought together.” — Vincent van Gogh

This PR strengthens the repository’s GitHub configuration with Lychee link checks, structured issue templates, and helpful community links, while keeping blank issues enabled.

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