Skip to content

Improve README accuracy and links - #27

Merged
glenn-jocher merged 1 commit into
mainfrom
docs/readme-cleanup
Jun 11, 2026
Merged

Improve README accuracy and links#27
glenn-jocher merged 1 commit into
mainfrom
docs/readme-cleanup

Conversation

@glenn-jocher

@glenn-jocher glenn-jocher commented Jun 11, 2026

Copy link
Copy Markdown
Member

Summary

  • aligns repository structure guidance with the current root hook script layout
  • corrects the pre-commit config example to point at ultralytics/pre-commit
  • retargets contributor and license links to this repository

Validation

  • git diff --check
  • lychee README.md
  • python -m py_compile capitalize_comments.py

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

📘 This PR updates the README.md to match the current ultralytics/pre-commit repository structure and links, improving setup instructions and contributor guidance.

📊 Key Changes

  • 🗂️ Replaced references to a hooks/ directory with the correct explanation that hook scripts live at the repository root, or can be placed elsewhere if referenced properly.
  • ✏️ Renamed the section from “Hook Scripts in hooks Directory” to the more accurate “Available Hook Scripts”.
  • 🔗 Fixed example hook paths in .pre-commit-hooks.yaml, changing entry: hooks/your_hook_script.py to entry: your_hook_script.py.
  • 🛠️ Updated contribution instructions so new hooks are no longer required to be placed in hooks/, reflecting the actual project layout.
  • 🌐 Corrected the repository URL in the usage example from ultralytics/pre-commit-hooks to ultralytics/pre-commit.
  • 👥 Updated contributor and license links to point to this repository instead of the main ultralytics/ultralytics repo.

🎯 Purpose & Impact

  • ✅ Makes the documentation accurate, reducing confusion for users setting up these pre-commit hooks.
  • 🚀 Helps contributors add new hooks correctly without following outdated folder structure guidance.
  • 🔍 Prevents broken links and incorrect repo references when users copy setup examples from the README.
  • 🤝 Improves the overall developer experience by ensuring the docs reflect how the repository actually works today.

@UltralyticsAssistant UltralyticsAssistant added documentation Improvements or additions to documentation fixed Bug has been resolved priority: low Low urgency; can wait behind higher-priority work. labels Jun 11, 2026
@UltralyticsAssistant

Copy link
Copy Markdown
Member

👋 Hello @glenn-jocher, thank you for submitting a ultralytics/pre-commit 🚀 PR! This is an automated message to help with review readiness—an engineer will assist you shortly 😊 Please review the checklist below to help ensure a smooth integration:

  • 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/pre-commit 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

The README updates look clean and consistent with the stated goal of fixing repository structure descriptions and incorrect links. I did not find any clear accuracy, logic, or maintainability issues in the changed lines.

@glenn-jocher
glenn-jocher merged commit fddb333 into main Jun 11, 2026
4 checks passed
@glenn-jocher
glenn-jocher deleted the docs/readme-cleanup branch June 11, 2026 01:42
@UltralyticsAssistant

Copy link
Copy Markdown
Member

🎉 Merged! Thanks, @glenn-jocher, for tightening up the README.md and bringing the docs in line with the actual ultralytics/pre-commit repo structure.

“Details make perfection, and perfection is not a detail.” — Leonardo da Vinci

This update is a great example of that idea in action: clearer hook paths, accurate repo references, and better contributor guidance all add up to a smoother experience for users and maintainers alike. Really appreciate the thoughtful cleanup and the attention to developer experience.

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 fixed Bug has been resolved priority: low Low urgency; can wait behind higher-priority work.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants