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

Fix URL #13408

Merged
merged 2 commits into from
Nov 8, 2024
Merged

Fix URL #13408

merged 2 commits into from
Nov 8, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Nov 8, 2024

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Minor updates to the GitHub workflow documentation in the YOLOv5 repository.

πŸ“Š Key Changes

  • Adjusted a broken link in the GitHub workflow documentation for custom training to ensure correct path to training tips guide.
  • Removed promotional content related to YOLOv8 from the workflow documentation file.

🎯 Purpose & Impact

  • πŸ› οΈ Purpose: The update to the link path corrects a minor documentation error to improve user access to training resources, and the removal of YOLOv8 promotional content keeps the focus on YOLOv5-specific workflow tasks.
  • πŸ“ˆ Impact: Users will experience improved clarity and accessibility when seeking guidance on custom training, avoiding potential confusion caused by mislinks or unrelated promotional content.

Signed-off-by: Glenn Jocher <[email protected]>
@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Nov 8, 2024
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @glenn-jocher, thank you for submitting an ultralytics/yolov5 πŸš€ PR! Your attention to detail in maintaining clear and accurate documentation is highly appreciated. Please review this checklist to ensure a smooth merger of your contribution:

  • βœ… Define a Purpose: Your PR's purpose of correcting the link in the workflow documentation is clear. If there are any relevant issues this addresses, please mention them in your description.
  • βœ… Synchronize with Source: Make sure your PR is up-to-date with the main branch of ultralytics/yolov5. You can do this by clicking the 'Update branch' button or by running git pull and git merge main locally.
  • βœ… Ensure CI Checks Pass: Confirm that all Ultralytics Continuous Integration (CI) checks are green. If any fail, please investigate and resolve them.
  • βœ… Update Documentation: Though this is a minor change, ensuring all related documentation reflects such corrections is crucial. Thanks for maintaining clarity!
  • βœ… Add Tests: For documentation updates, tests might not be applicable, but do ensure other aspects of the codebase remain unaffected.
  • βœ… Sign the CLA: If this is your first contribution, please confirm you have signed the Contributor License Agreement by stating "I have read the CLA Document and I sign the CLA" in a comment.
  • βœ… Minimize Changes: Your changes are precise and focused, adhering to best practices. "Simplicity is the outcome of technical subtlety. It is the goal, not the starting point." β€” Maurice Saatchi

For detailed instructions, check out our Contributing Guide. An Ultralytics engineer will review your PR soon, but feel free to leave any questions in the comments. Thank you for enhancing our user experience! πŸš€

Signed-off-by: Glenn Jocher <[email protected]>
@glenn-jocher glenn-jocher merged commit 3760e0e into master Nov 8, 2024
7 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch November 8, 2024 22:22
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