Skip to content
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

Update ci.yml badge #30

Merged
merged 11 commits into from
Jan 14, 2025
Merged

Update ci.yml badge #30

merged 11 commits into from
Jan 14, 2025

Conversation

RizwanMunawar
Copy link
Member

@RizwanMunawar RizwanMunawar commented Jan 14, 2025

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Updated hyperlinks and examples in Ultralytics Jupyter notebooks for better usability and functionality. πŸ› οΈ

πŸ“Š Key Changes

  • Fixed CI badge links in multiple notebooks to accurately point to the ci.yml workflow file. βœ…
  • Adjusted pip command examples and included explicit shell commands (e.g., adding ! prefixes for clarity in code cells). πŸ§‘β€πŸ’»
  • Improved outputs and execution tracking for Colab to reflect example setups accurately. πŸ“ˆ

🎯 Purpose & Impact

  • Enhanced clarity for users: Accurate CI badge links provide better credibility and accessibility to the CI status. 🌐
  • Improved notebook usability: Updated code examples ensure seamless execution, especially in Colab or Python environments, reducing confusion for users. πŸš€
  • Better guidance in workflows: Users now have clearer command instructions to replicate examples effectively, making the learning curve smoother. πŸ“˜

@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops documentation Improvements or additions to documentation labels Jan 14, 2025
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @RizwanMunawar, thank you for submitting this ultralytics/notebooks πŸš€ PR! To ensure a smooth and efficient integration of your contributions, please review the following checklist:

  • βœ… Define a Purpose: Provide a clear explanation of the purpose of this PR in your description and link any relevant issues. Ensure commit messages are clear and descriptive, adhering to the repository's guidelines.
  • βœ… Synchronize with Source: Ensure your branch is synchronized with the latest main branch. If it's not up-to-date, please click the 'Update branch' button or run git pull followed by git merge main locally.
  • βœ… Ensure CI Checks Pass: Verify that all Ultralytics Continuous Integration (CI) tests have passed successfully. If you find a failing check, please address the issue.
  • βœ… Update Documentation: If your changes introduce or modify functionality, update the relevant documentation as needed.
  • βœ… Add Tests: For significant changes, include new tests or update existing tests to cover your modifications. Confirm that all tests pass.
  • βœ… Sign the CLA: If this is your first contribution to Ultralytics, please sign our Contributor License Agreement. You can do so by commenting, "I have read the CLA Document and I hereby sign the CLA."
  • βœ… Minimize Changes: Ensure your PR contains only the minimum necessary code changes for your contribution. Remember what Bruce Lee said: "It is not daily increase, but daily decrease. Hack away at the unessential."

For more details about contributing, see our complete Contributing Guide. If you encounter any questions or need assistance, feel free to leave a comment below. πŸ”§πŸ˜Š

This is an automated message πŸ€–; an Ultralytics team member will review your PR and provide additional feedback shortly. Thank you for contributing to Ultralytics! πŸš€

Copy link
Member

@ambitious-octopus ambitious-octopus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ambitious-octopus ambitious-octopus merged commit d6a9517 into main Jan 14, 2025
2 checks passed
@ambitious-octopus ambitious-octopus deleted the !-fix branch January 14, 2025 17:07
@UltralyticsAssistant
Copy link
Member

πŸŽ‰ Exciting newsβ€”your PR has been merged! Huge thanks to @RizwanMunawar and @ambitious-octopus for elevating Ultralytics notebooks with improved clarity and usability. πŸ’‘ Your thoughtful updates to links and examples are sure to make a lasting impact for users worldwide! 🌍✨

As Marcus Aurelius once said, "What we do now echoes in eternity." Your contributions here will empower countless learners and developers to explore and grow seamlessly. πŸš€ Keep shining and thank you for being part of this journey! πŸ™Œ

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops GitHub Devops or MLops documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants