Skip to content

Update formatting, headers, and redirects#86

Merged
glenn-jocher merged 1 commit into
mainfrom
update-format-headers-redirects-20260612201348
Jun 12, 2026
Merged

Update formatting, headers, and redirects#86
glenn-jocher merged 1 commit into
mainfrom
update-format-headers-redirects-20260612201348

Conversation

@pderrenger

@pderrenger pderrenger commented Jun 12, 2026

Copy link
Copy Markdown
Member

Updates repository maintenance artifacts:

  • formats supported source and config files
  • applies public AGPL source headers
  • formats Python docstrings
  • updates links to final redirect destinations

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

🧹 This PR makes small documentation and formatting cleanups across the template repo, mainly standardizing Ultralytics docs links and tidying a unittest file.

📊 Key Changes

  • Updated multiple Ultralytics documentation links to use a consistent URL format without trailing slashes:
    • Contributing Guide links in issue templates, README files, docs, and tests
    • Code of Conduct and CI-related docs links in template documentation
  • Refreshed references in:
    • .github/ISSUE_TEMPLATE/bug-report.yml
    • .github/ISSUE_TEMPLATE/feature-request.yml
    • README.md
    • docs/README.md
    • template/README.md
    • tests/README.md
  • Cleaned up tests/test_with_unittest.py
    • Added spacing for better readability
    • Removed trailing whitespace
    • No functional test logic changes

🎯 Purpose & Impact

  • Improves documentation consistency across the project 📚
  • Helps reduce the chance of broken, duplicated, or mismatched links to Ultralytics help pages 🔗
  • Makes the repository feel more polished and easier for contributors to navigate 🤝
  • Keeps test files aligned with common Python style expectations without affecting behavior ✅
  • Overall impact is low-risk and maintenance-focused: no feature changes, no API changes, and no runtime behavior changes 🛠️

@codecov

codecov Bot commented Jun 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@UltralyticsAssistant UltralyticsAssistant added documentation Improvements or additions to documentation enhancement New feature or request priority: low Low urgency; can wait behind higher-priority work. labels Jun 12, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @pderrenger, thank you for submitting a ultralytics/template 🚀 PR! This is an automated message to help streamline review, and an engineer will assist you soon. Please review the checklist below for smooth integration ✨

  • 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/template 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

The PR looks clean. The changes are limited to documentation URL normalization and harmless whitespace cleanup in the unittest file, and I don't see any functional, maintainability, or error-handling issues in the diff.

@glenn-jocher glenn-jocher merged commit e730c46 into main Jun 12, 2026
14 checks passed
@glenn-jocher glenn-jocher deleted the update-format-headers-redirects-20260612201348 branch June 12, 2026 20:37
@UltralyticsAssistant

Copy link
Copy Markdown
Member

🎉 Merged! Thanks @pderrenger, with contributions from @glenn-jocher, for these thoughtful cleanup updates to the template repo.

As Aristotle said, “Excellence is an art won by training and habituation.” This PR reflects that mindset well: small documentation and formatting improvements like consistent Ultralytics docs links and cleaner test files help keep the project polished, reliable, and easier for contributors to navigate.

Really appreciate the attention to detail here—low-risk maintenance work like this makes a meaningful difference. 🚀

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

Labels

documentation Improvements or additions to documentation enhancement New feature or request priority: low Low urgency; can wait behind higher-priority work.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants