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

Add Ultralytics actions workflow in format.yml #38

Merged
merged 1 commit into from
Jan 1, 2024

Conversation

UltralyticsAssistant
Copy link
Member

@UltralyticsAssistant UltralyticsAssistant commented Jan 1, 2024

This pull request adds a workflow to automatically format code and documentation.

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Implementation of an Automated Formatting Workflow for Code and Docs

πŸ“Š Key Changes

  • Created a new GitHub Actions workflow file named format.yml.
  • This workflow triggers on pushes and pull requests to the main and master branches.
  • It sets up the workflow to run on the latest Ubuntu runners.
  • Defines steps to check out the repo and run formatting actions using Ultralytics' custom GitHub Actions.

🎯 Purpose & Impact

  • Purpose: To ensure consistent code and documentation formatting across all contributions.
  • Impact: Contributes to cleaner codebases and documentation, making it easier for developers and users to read and contribute. Automating the process enhances efficiency and prevents human errors related to formatting. πŸ› οΈ Users can expect a smoother experience when navigating code and docs, thanks to standardized presentation. πŸ“‘

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

πŸ‘‹ Hello @UltralyticsAssistant, thank you for submitting a YOLOv8 πŸš€ PR! To allow your work to be integrated as seamlessly as possible, we advise you to:

  • βœ… Verify your PR is up-to-date with ultralytics/ultralytics main branch. If your PR is behind you can update your code by clicking the 'Update branch' button or by running git pull and git merge main locally.
  • βœ… Verify all YOLOv8 Continuous Integration (CI) checks are passing.
  • βœ… Update YOLOv8 Docs for any new or updated features.
  • βœ… Reduce changes to the absolute minimum required 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

See our Contributing Guide for details and let us know if you have any questions!

@glenn-jocher glenn-jocher merged commit a835643 into main Jan 1, 2024
5 checks passed
@glenn-jocher glenn-jocher deleted the add-format-workflow-20240101030532 branch January 1, 2024 02:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants