This pull request adds an improved Ultralytics Actions workflow to automatically format code and documentation to the new Ultralytics official standards maintained at https://github.com/ultralytics/actions.
Four individual actions are run by default. To disable actions, set them to false, i.e. 'python: false'.
To customize an action use a pyproject.toml file in this repo, and see the individual action repo for details.
Updated the GitHub Actions workflow for code formatting and enhanced the project README for better clarity.
π Key Changes
The GitHub Actions workflow file .github/workflows/format.yml has been updated to use the Ultralytics formatting actions.
Now specifically formats Python code, docstrings, markdown files, and checks for spelling errors.
The README file has received minor updates adding line breaks for improved readability.
π― Purpose & Impact
π Automating Code Quality: The updated workflow ensures that all contributions adhere to Ultralytics formatting standards automatically, leading to cleaner and more maintainable code.
π Improved Documentation: The changes in the README file enhance the presentation and make the instructions clearer, potentially attracting more contributors and users.
β¨ A Spelling Check: Spelling validation will help in maintaining professional and error-free documentation.
This pull request adds an improved Ultralytics Actions workflow to automatically format code and documentation to the new Ultralytics official standards maintained at https://github.com/ultralytics/actions.
Four individual actions are run by default. To disable actions, set them to false, i.e. 'python: false'.
To customize an action use a
pyproject.toml
file in this repo, and see the individual action repo for details.π οΈ PR Summary
Made with β€οΈ by Ultralytics Actions
π Summary
Updated the GitHub Actions workflow for code formatting and enhanced the project README for better clarity.
π Key Changes
.github/workflows/format.yml
has been updated to use the Ultralytics formatting actions.π― Purpose & Impact