Skip to content

Align README tail sections and trim pyproject config - #54

Merged
glenn-jocher merged 1 commit into
mainfrom
pass2-branding
Aug 2, 2026
Merged

Align README tail sections and trim pyproject config#54
glenn-jocher merged 1 commit into
mainfrom
pass2-branding

Conversation

@glenn-jocher

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

Copy link
Copy Markdown
Member

Second standardization pass: canonical README tail plus a pyproject cleanup.

README

  • Renamed the closing sections to the canonical headings: ## 📄 License and ## 📮 Contact.
  • Contact pointed readers at this repo's GitHub Issues, but the Issues tab is disabled here, so there was nowhere to file anything. It now points at ultralytics/ultralytics issues.

pyproject.toml

  • Dropped py-modules = ["clip"]. It names a top-level clip.py that does not exist — clip is a package, already discovered by packages.find. Verified the built wheel is byte-for-byte identical in contents before and after.
  • Trimmed the codespell config, which was copied verbatim from ultralytics/ultralytics. The 33-word ignore-words-list was YOLO vocabulary (strack, dota, segway, MOT, …); only whet is actually needed, for the "Northern Saw whet Owl" class name in data/prompts.md. The skip list named paths this repo does not have (./docs/??/*.md, mkdocs_??.yml, /runs, export formats) and now lists just the vendored BPE vocabulary and the notebook with embedded image output.

Verified locally: codespell exits clean with the new config, and it correctly fails if whet or the notebook skip is removed.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

🧹 Cleans up project packaging, documentation links, and codespell configuration for improved maintainability.

📊 Key Changes

  • Updated README section labels:
    • Renamed “📝 License” to “📄 License”.
    • Renamed “📬 Contact Us” to “📮 Contact”.
  • Corrected the GitHub Issues link to point to the main Ultralytics repository.
  • Removed the obsolete py-modules = ["clip"] packaging configuration.
  • Simplified codespell settings:
    • Reduced the ignored-word list to the specific valid class name whet.
    • Replaced broad file exclusions with targeted exclusions for the vendored BPE vocabulary and notebook.

🎯 Purpose & Impact

  • 📦 Improves Python package discovery by relying on automatic package detection.
  • 🔍 Makes spelling checks more precise, helping identify genuine documentation errors.
  • 🔗 Directs users to the correct location for reporting issues and requesting features.
  • 🧼 Provides clearer, more maintainable project documentation and configuration without changing core CLIP functionality.

@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops documentation Improvements or additions to documentation labels Aug 2, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/CLIP 🚀 PR! 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. This automated message is provided to help with the review, and an engineer will assist with any follow-up 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 PR. The README heading and contact-link updates are consistent with the stated standardization, and the setuptools and codespell cleanup matches the repository layout and existing spelling-check workflow. No actionable issues found.

@glenn-jocher
glenn-jocher merged commit 488e81a into main Aug 2, 2026
9 checks passed
@glenn-jocher
glenn-jocher deleted the pass2-branding branch August 2, 2026 19:01
@UltralyticsAssistant

Copy link
Copy Markdown
Member

🎉 Thank you, @glenn-jocher, for this thoughtful cleanup—merged successfully!

As Leonardo da Vinci said, “Simplicity is the ultimate sophistication.” By streamlining packaging, refining codespell configuration, and clarifying documentation links and labels, this PR improves maintainability and makes the project easier to use and contribute to, without changing core CLIP functionality. We truly appreciate your continued contributions!

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