Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update README.md #42

Merged
merged 1 commit into from
Jan 9, 2024
Merged

Update README.md #42

merged 1 commit into from
Jan 9, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jan 9, 2024

Thank you 🙏 for your contribution to Ultralytics 🚀! Your effort in enhancing our repositories is greatly appreciated. To streamline the process and assist us in integrating your Pull Request (PR) effectively, please follow these steps:

  1. Check for Existing Contributions: Before submitting, kindly explore existing PRs to ensure your contribution is unique and complementary.

  2. Link Related Issues: If your PR addresses an open issue, please link it in your submission. This helps us better understand the context and impact of your contribution.

  3. Elaborate Your Changes: Clearly articulate the purpose of your PR. Whether it's a bug fix or a new feature, a detailed description aids in a smoother integration process.

  4. Ultralytics Contributor License Agreement (CLA): To uphold the quality and integrity of our project, we require all contributors to sign the CLA. Please confirm your agreement by commenting below:

    I have read the CLA Document and I hereby sign the CLA

For more detailed guidance and best practices on contributing, refer to our ✅ Contributing Guide. Your adherence to these guidelines ensures a faster and more effective review process.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Updated badges in the Ultralytics documentation README for better clarity and accuracy.

📊 Key Changes

  • Removed the badge linking to the Ultralytics JSON2YOLO repository workflow, which was not relevant to the current documentation repository.
  • Kept badges for build deployment and broken link checks, ensuring they accurately reflect the status of the documentation repository.

🎯 Purpose & Impact

  • Improved Clarity: Eliminating the unrelated badge helps prevent confusion, making it clear which automated processes apply to the Ultralytics Docs.
  • Enhanced Accuracy: Maintaining and correcting the badges ensures users have up-to-date information on the health of the documentation, such as successful deployment and link integrity.
  • User Trust: Accurate and relevant badges contribute to user trust, as they can see at a glance that the documentation is well-maintained.

@glenn-jocher glenn-jocher merged commit bf6c8bb into main Jan 9, 2024
3 of 5 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch January 9, 2024 12:34
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant