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 #19

Closed
wants to merge 2 commits into from
Closed

Update README.md #19

wants to merge 2 commits into from

Conversation

glenn-jocher
Copy link
Member

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

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Minor formatting update in the README for improved readability.

πŸ“Š Key Changes

  • Added two newlines in the README description section for spacing.

🎯 Purpose & Impact

  • πŸ“ Readability Improvement: Enhances document structure making it slightly easier to read.
  • πŸ” Clarification: No content changes, so no direct impact on the core functionality or features.

@UltralyticsAssistant UltralyticsAssistant added the enhancement New feature or request label Oct 16, 2024
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @glenn-jocher, thank you for submitting an ultralytics/nudar πŸš€ 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/nudar 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: Since your PR involves documentation changes, ensure all relevant sections are consistent with the new formatting.
  • βœ… Add Tests: Although your PR is documentation-related, if a change indirectly affects functionality, make sure tests are in place and 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 bug fix or 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. An Ultralytics engineer will also assist you shortly. Thank you for contributing to Ultralytics! πŸš€βœ¨

@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch October 16, 2024 00:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants