Skip to content

Add Ultralytics Blog badge in README.md and README.zh-CN.md #13558

New issue

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

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

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

RizwanMunawar
Copy link
Member

@RizwanMunawar RizwanMunawar commented Apr 8, 2025

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Improved documentation with a new Ultralytics Blog link and streamlined Comet logger configuration details.

πŸ“Š Key Changes

  • Added a link to the Ultralytics Blog in the README files (English and Chinese). πŸ“
  • Removed outdated environment variable examples from the Comet logger README for a cleaner and more concise guide. πŸš€

🎯 Purpose & Impact

  • Enhanced Accessibility: The new blog link makes it easier for users to access valuable insights, updates, and tutorials from Ultralytics. 🌐
  • Simplified Documentation: Streamlining the Comet logger section reduces confusion and ensures users focus on the most relevant configuration options. πŸ“–
  • Improved User Experience: These updates make the documentation more user-friendly and informative for both new and experienced users. 😊

Signed-off-by: Muhammad Rizwan Munawar <muhammadrizwanmunawar123@gmail.com>
Signed-off-by: Muhammad Rizwan Munawar <muhammadrizwanmunawar123@gmail.com>
@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Apr 8, 2025
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @RizwanMunawar, thank you for submitting an ultralytics/yolov5 πŸš€ PR! 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/yolov5 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 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! 🌟

This is an automated response. An Ultralytics engineer will review your PR and provide additional feedback soon. πŸš€

@RizwanMunawar RizwanMunawar self-assigned this Apr 8, 2025
@RizwanMunawar RizwanMunawar changed the title Add Ultralytics Blog badge in README.md, README.zh-CN.md and docs Add Ultralytics Blog badge in README.md and README.zh-CN.md Apr 8, 2025
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