Skip to content

Trim copy-pasted pyproject config - #101

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

Trim copy-pasted pyproject config#101
glenn-jocher merged 1 commit into
mainfrom
pass2-pyproject-cleanup

Conversation

@glenn-jocher

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

Copy link
Copy Markdown
Member

Two leftovers copied from ultralytics/ultralytics that do not apply here. Since new Ultralytics Python projects are copied from this repo, both propagate.

  • Removed the [tool.codespell] table. Every word in ignore-words-list (strack, dota, segway, crate, …) is a YOLO-specific term, and the only place any of them appears in this repo is that line itself; the skip globs point at *.csv, docs/??/ and docs/mkdocs_??.yml, none of which exist here. Ultralytics Actions already passes its own comprehensive --ignore-words-list on the command line, and I verified codespell still reports clean on this repo with the table gone.
  • Dropped the Documentation project URL. docs.ultralytics.com hosts the YOLO documentation, not docs for this package, so the link sends users somewhere unrelated. The remaining Homepage/Source/Bug Reports/Changelog URLs are correct.

Verified locally: TOML parses, pip install -e ".[dev]", pytest (7 passed) and example-cli-command all fine.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Simplifies the project configuration by removing outdated documentation and codespell settings. 🧹

📊 Key Changes

  • Removed the "Documentation" URL from pyproject.toml.
  • Deleted the [tool.codespell] configuration, including custom ignored words and skipped file patterns.

🎯 Purpose & Impact

  • Keeps the template’s package metadata more focused and up to date. ✨
  • Removes repository-specific spelling exceptions and exclusions that may no longer be needed.
  • Could allow codespell to check a broader set of files and flag previously ignored terms, depending on the active tooling configuration. 🔍

@UltralyticsAssistant UltralyticsAssistant added the enhancement New feature or request label Aug 2, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/template 🚀 PR! This is an automated message, and an engineer will assist as needed. 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/template 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, minimal metadata/config cleanup. The removed codespell overrides are not referenced elsewhere in this repository, and the remaining project URLs are valid package-relevant links. No actionable issues found.

@codecov

codecov Bot commented Aug 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@glenn-jocher
glenn-jocher merged commit cf18b5f into main Aug 2, 2026
15 checks passed
@glenn-jocher
glenn-jocher deleted the pass2-pyproject-cleanup branch August 2, 2026 18:56
@UltralyticsAssistant

Copy link
Copy Markdown
Member

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

“Simplicity is the ultimate sophistication.” — Leonardo da Vinci

By removing outdated metadata and codespell exceptions, this update keeps the project configuration focused, current, and easier to maintain while enabling broader spelling checks. We appreciate your contribution to a cleaner, more consistent template!

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

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants