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 README.md #9

Merged
merged 4 commits into from
Oct 14, 2024
Merged

Update README.md #9

merged 4 commits into from
Oct 14, 2024

Conversation

glenn-jocher
Copy link
Member

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

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

This update enhances the Ultralytics Handbook documentation for clarity and usability.

πŸ“Š Key Changes

  • Improved introduction to the Handbook for better context.
  • Updated installation and local development instructions for MkDocs.
  • Enhanced deployment and contribution guidelines.

🎯 Purpose & Impact

  • πŸ“˜ Clarity: Provides a clearer understanding of the Handbook's purpose and structure.
  • πŸ› οΈ Ease of Use: Simplifies the setup process for those working on documentation.
  • 🀝 Engagement: Encourages community involvement with updated contribution information.

@UltralyticsAssistant UltralyticsAssistant added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 14, 2024
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @glenn-jocher, thank you for submitting a pull request to the ultralytics/handbook repository! πŸš€ This is an automated response to help guide your contribution process. An Ultralytics engineer will review your PR soon.

Please review the following checklist to ensure everything is in order:

  • βœ… Define a Purpose: Make sure your pull request description clearly explains its purpose. If it addresses any relevant issues, please link them. Ensure your commit messages are clear and follow the project's conventions.
  • βœ… Synchronize with Source: Check that your pull request is up-to-date with the main branch of the repository by clicking 'Update branch' or running git pull and git merge main locally.
  • βœ… Ensure CI Checks Pass: Confirm that all Ultralytics Continuous Integration (CI) checks pass. If any fail, address the issues promptly.
  • βœ… Update Documentation: If your changes affect functionality or features, update the related documentation accordingly.
  • βœ… Add Tests: Include any necessary tests for your changes and verify that all existing and new tests pass successfully.
  • βœ… Sign the CLA: If this is your first contribution, please sign our Contributor License Agreement by adding "I have read the CLA Document and I sign the CLA" in a new comment on this PR.
  • βœ… Minimize Changes: Ensure your changes are concise and directly related to the purpose of your pull request. "Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away." β€” Antoine de Saint-ExupΓ©ry

For further assistance, refer to our Contributing Guide. If you have any questions, feel free to leave a comment. Thank you for your efforts in improving the Ultralytics Handbook! 😊

@glenn-jocher glenn-jocher merged commit 4ff77c4 into main Oct 14, 2024
1 check passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch October 14, 2024 11:01
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants