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

Reformat #22

Merged
merged 2 commits into from
Nov 20, 2024
Merged

Reformat #22

merged 2 commits into from
Nov 20, 2024

Conversation

glenn-jocher
Copy link
Member

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

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

This PR introduces code formatting improvements and updates the Inkeep widget version in Ultralytics' handbook workflows and documentation scripts.

πŸ“Š Key Changes

  • Code Style Enhancements: Updated the format of code in multiple YAML and JavaScript files for improved readability, mainly through consistent use of double quotes and indentation.
  • Inkeep Widget Update: Upgraded the Inkeep widget script to a newer version (0.3.18).

🎯 Purpose & Impact

  • Human-Readable Code: The changes to code styling enhance readability and maintainability, making it easier for developers to understand and collaborate on the code.
  • Updated Inkeep Widget: The version update of the Inkeep widget ensures the use of the latest features and improvements offered by the library, potentially enhancing user interaction with the documentation site.

@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops documentation Improvements or additions to documentation enhancement New feature or request labels Nov 20, 2024
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @glenn-jocher! Thank you for submitting a PR to the ultralytics/handbook repository πŸš€! This is an automated response to help streamline your contribution, and one of our Ultralytics engineers will provide further assistance soon. Please review the following checklist to ensure a smooth integration of your work:

  • βœ… Define a Purpose: Clearly explain the purpose of your changes in your PR description, ensuring that your commit messages are clear and concise. If your PR addresses a specific issue, please link to it in the description by using a relevant issue link.
  • βœ… Synchronize with Source: Check that your branch is up to date with ultralytics/handbook's main branch. This can be done by clicking the 'Update branch' button on GitHub or running git pull and git merge main locally.
  • βœ… Ensure CI Checks Pass: Confirm that all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please resolve the issues.
  • βœ… Update Documentation: Make sure that any updates to existing documentation are included if your changes require it. You can find related documentation here.
  • βœ… Add Tests: If applicable, include tests or update existing tests to cover your changes, and verify that all tests pass successfully.
  • βœ… Sign the CLA: If this is your first contribution to an Ultralytics repository, please sign our Contributor License Agreement (CLA) by declaring "I have read the CLA Document and I sign the CLA" in a new comment.
  • βœ… Minimize Changes: Keep your changes to the essential minimum to achieve the intended improvement or fix. As Bruce Lee wisely put it, "It is not daily increase but daily decrease, hack away the unessential."

For further details, you can refer to the Contributing Guide. If you have any questions or need assistance, feel free to leave a comment. Thank you for your valuable contribution! πŸš€

@glenn-jocher glenn-jocher merged commit 63eb05c into main Nov 20, 2024
1 check passed
@glenn-jocher glenn-jocher deleted the update branch November 20, 2024 15:27
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants