Skip to content

Apply canonical README tail sections - #26

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

Apply canonical README tail sections#26
glenn-jocher merged 1 commit 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

📝 Updated the MSVM README to improve contribution guidance, licensing information, contact details, and social media links.

📊 Key Changes

  • Renamed the Contribute, License, and Contact Us sections with updated emoji headings.
  • Reworked contribution instructions to clearly explain how to:
    • Report bugs
    • Request features
    • Submit pull requests
    • Share feedback through the survey
  • Refined AGPL-3.0 and Enterprise License descriptions, including updated links.
  • Simplified guidance for GitHub Issues and Discord community support.
  • Updated the YouTube link to include a direct subscription prompt.

🎯 Purpose & Impact

  • ✅ Makes the README easier for new contributors and users to navigate.
  • 🤝 Provides clearer paths for reporting issues and contributing code.
  • ⚖️ Improves understanding of open-source and commercial licensing options.
  • 📣 Strengthens access to Ultralytics community channels and social media.
  • 🔧 No functional code changes are introduced; the impact is limited to documentation and project discoverability.

@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/msvm 🚀 PR! This is an automated welcome message, and an 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/msvm 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 update. The revised tail consistently applies the requested canonical headings, contribution routes, licensing language, contact text, and YouTube subscription link without affecting the MSVM documentation body.

@glenn-jocher
glenn-jocher merged commit 579a1e7 into main Aug 2, 2026
4 checks passed
@glenn-jocher
glenn-jocher deleted the canonical-readme-tail branch August 2, 2026 18:56
@UltralyticsAssistant

Copy link
Copy Markdown
Member

🎉 Thank you, @glenn-jocher, for this valuable documentation update—and congratulations on the merge!

“The best way to predict the future is to create it.” — Peter Drucker

By clarifying contribution guidance, licensing information, support channels, and community links, this PR makes it easier for users and contributors to find their path forward and help shape the future of MSVM. Your thoughtful improvements strengthen project discoverability and community engagement. 🤝

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