Skip to content

Update pyproject.toml codespell settings#33

Merged
glenn-jocher merged 2 commits intomainfrom
glenn-jocher-patch-2
Oct 29, 2025
Merged

Update pyproject.toml codespell settings#33
glenn-jocher merged 2 commits intomainfrom
glenn-jocher-patch-2

Conversation

@glenn-jocher
Copy link
Member

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

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Adds a codespell configuration to standardize spelling checks across the repo and fixes a minor spelling in an ImageNet class name in a notebook. ✅

📊 Key Changes

  • Introduced a codespell configuration in pyproject.toml with:
    • Custom ignore-word list to reduce false positives.
    • Extensive skip patterns for binaries, large assets, notebooks, and generated files.
  • Updated a class label in notebooks/Prompt_Engineering_for_ImageNet.ipynb:
    • Changed "sulphur-crested cockatoo" to "sulfur-crested cockatoo" (spelling consistency).

🎯 Purpose & Impact

  • Improves code and documentation quality by catching real typos while avoiding noise from known terms and large files. 🧹
  • Reduces CI friction for contributors by minimizing false-positive spellcheck failures. 🤝
  • Ensures consistent, user-facing text (like class names) without affecting model behavior or APIs. 🧠✨

glenn-jocher and others added 2 commits October 29, 2025 18:28
@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops documentation Improvements or additions to documentation labels Oct 29, 2025
@UltralyticsAssistant
Copy link
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/CLIP 🚀 PR! This is an automated message; an engineer will follow up 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/CLIP 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 e2590b3 into main Oct 29, 2025
5 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-2 branch October 29, 2025 10:32
@UltralyticsAssistant
Copy link
Member

Merged with gratitude — thank you, @glenn-jocher! “Quality is not an act, it is a habit.” — Aristotle. Your work in PR #33 makes that habit easier for everyone: the thoughtful codespell configuration in pyproject.toml and the precise ImageNet label update in Prompt_Engineering_for_ImageNet.ipynb reduce CI noise, improve contributor experience, and keep user-facing text consistent—all without touching model behavior.

Appreciate the attention to detail and the boost to team velocity. Big thanks from the Ultralytics and Ultralytics HUB community!

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

Labels

devops GitHub Devops or MLops documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants