Skip to content

Apply canonical README tail sections - #31

Merged
glenn-jocher merged 2 commits into
mainfrom
canonical-readme-tail
Aug 2, 2026
Merged

Apply canonical README tail sections#31
glenn-jocher merged 2 commits into
mainfrom
canonical-readme-tail

Conversation

@glenn-jocher

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

Copy link
Copy Markdown
Member

Aligns the README tail with the canonical Ultralytics structure. The scientific and historical body content is unchanged.

  • Replace the Contribute, License, and Contact sections with the canonical ## 💡 Contribute, ## 📄 License, and ## 📮 Contact text, so headings and wording match the rest of the org.
  • Contribute now lists the issue, feature-request, pull-request, and survey routes explicitly instead of a single prose paragraph.
  • License now presents both options (AGPL-3.0 and Enterprise) in the standard two-bullet form, and the OSI link uses the canonical agpl-3.0 URL.
  • Point the footer YouTube icon at the canonical ?sub_confirmation=1 URL.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

📚 Refined the README to improve repository branding, contribution guidance, licensing information, and community links.

📊 Key Changes

  • Renamed the README title to “Ultralytics MATLAB Functions” for clearer repository identification.
  • Reorganized the contribution section with separate guidance for:
    • 🐛 Reporting issues
    • 💡 Requesting features
    • 🔧 Submitting pull requests
    • 📝 Providing feedback
  • Updated the contributors image link to the main Ultralytics contributor page.
  • Clarified AGPL-3.0 and Enterprise licensing descriptions, with improved links.
  • Renamed “Get in Touch” to “Contact” and streamlined support instructions.
  • Updated the YouTube link to include a subscription prompt.

🎯 Purpose & Impact

  • ✅ Makes the repository’s purpose clearer to new users.
  • 🤝 Provides more actionable instructions for community contributions and support.
  • 📄 Improves licensing clarity for both open-source and commercial users.
  • 🔗 Keeps community and social links accurate and easier to use.
  • 🚀 No functional MATLAB code changes are introduced; the impact is limited to documentation and navigation improvements.

@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Aug 2, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/functions-matlab 🚀 PR! This automated message confirms that your README update is under review, and an engineer will assist with any follow-up. 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 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

Clean README-only canonicalization. The updated headings, contribution routes, licensing language, contact guidance, and YouTube subscription URL are internally consistent; no actionable issues found.

@glenn-jocher
glenn-jocher merged commit 85841f6 into main Aug 2, 2026
5 checks passed
@glenn-jocher
glenn-jocher deleted the canonical-readme-tail branch August 2, 2026 18:58
@UltralyticsAssistant

Copy link
Copy Markdown
Member

🎉 Thank you for merging this PR, @glenn-jocher!

“The future depends on what you do today.” — Mahatma Gandhi

These documentation improvements make the Ultralytics MATLAB Functions repository clearer, more welcoming, and easier to navigate for users and contributors. The refreshed branding, contribution guidance, licensing details, and community links will help today’s visitors—and tomorrow’s contributors—find the right path forward. 🚀

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants