Improve README accuracy and links - #27
Conversation
|
👋 Hello @glenn-jocher, thank you for submitting a
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
left a comment
There was a problem hiding this comment.
🔍 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.
|
🎉 Merged! Thanks, @glenn-jocher, for tightening up the “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. |
Summary
Validation
🛠️ PR Summary
Made with ❤️ by Ultralytics Actions
🌟 Summary
📘 This PR updates the
README.mdto match the currentultralytics/pre-commitrepository structure and links, improving setup instructions and contributor guidance.📊 Key Changes
hooks/directory with the correct explanation that hook scripts live at the repository root, or can be placed elsewhere if referenced properly.hooksDirectory” to the more accurate “Available Hook Scripts”..pre-commit-hooks.yaml, changingentry: hooks/your_hook_script.pytoentry: your_hook_script.py.hooks/, reflecting the actual project layout.ultralytics/pre-commit-hookstoultralytics/pre-commit.ultralytics/ultralyticsrepo.🎯 Purpose & Impact