Skip to content

Conversation

@glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Oct 29, 2025

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Standardizes “Acknowledgments” wording across the repo and adds Codespell configuration, improving documentation consistency and developer tooling 🧹✅

📊 Key Changes

  • Renames references from “ACKNOWLEDGEMENTS” to “ACKNOWLEDGMENTS” across README, license notes, eval scripts, and code comments.
  • Updates iOS project file references to use “ACKNOWLEDGMENTS”.
  • Minor comment tweak: “cancelled” → “canceled” in Swift code.
  • Adds [tool.codespell] configuration to pyproject.toml with custom ignore list and skip patterns.

🎯 Purpose & Impact

  • Improves consistency and professionalism by standardizing American English spelling throughout the project ✨
  • Clarifies license attributions by aligning all references to the correct “ACKNOWLEDGMENTS” file 📄
  • Enhances developer experience with built-in spell checking (Codespell), reducing future typos in CI/workflows 🛠️
  • Note: Potential issue in iOS app — the file was renamed to ACKNOWLDGEMENTS (missing “E”), while the Xcode project points to ACKNOWLEDGMENTS. This mismatch could break the reference in Xcode. Recommend aligning the filename and project reference to avoid build or packaging issues ⚠️📱

@UltralyticsAssistant UltralyticsAssistant added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 29, 2025
@UltralyticsAssistant
Copy link
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/mobileclip 🚀 PR! This automated assistant reviewed your update to standardize acknowledgments and add codespell settings. An Ultralytics engineer will assist shortly. 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/mobileclip 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! 🚀

@glenn-jocher glenn-jocher merged commit f472fbb into main Oct 29, 2025
5 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-2 branch October 29, 2025 10:28
@UltralyticsAssistant
Copy link
Member

🎉 Merged—awesome work, @glenn-jocher!

“Details make perfection, and perfection is not a detail.” — Leonardo da Vinci
Your PR PR #17: Documentation and Codespell improvements nails this spirit—standardizing “Acknowledgments” and adding Codespell tightens our docs, clarifies licensing references, and boosts developer experience across the board. Thank you for raising the bar on quality and consistency.

Small follow-up note: the iOS app appears to reference ACKNOWLEDGMENTS while the file may be named ACKNOWLDGEMENTS (missing “E”). Aligning the filename and Xcode project reference will prevent potential build/packaging hiccups.

Appreciate the thoughtful polish and tooling upgrade—this is how we keep Ultralytics projects world-class. 🚀

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants