Skip to content

Conversation

glenn-jocher
Copy link
Member

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

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Minor updates to the README and Python module to enhance clarity and accuracy.

πŸ“Š Key Changes

  • Updated a status badge link in the README to reflect the new Template CI workflow.
  • Changed the application name reference in the module from "Ultralytics YOLO" to "Ultralytics Template."

🎯 Purpose & Impact

  • Ensures the README reflects the current CI setup, improving transparency and providing users with accurate workflow information. πŸ“ˆ
  • Clarifies the module's purpose by aligning the application name with its actual utility, reducing confusion for developers. 🧩

@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Oct 29, 2024
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @glenn-jocher, thank you for submitting an ultralytics/template πŸš€ PR! This is an automated response to assist you, and an Ultralytics engineer will follow up to help soon.

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 update. "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 changed the title Add badge to README Add CI badge to README Oct 29, 2024
@glenn-jocher glenn-jocher merged commit 25b7584 into main Oct 29, 2024
8 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch October 29, 2024 16:41
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants