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.
Enhancements to the automatic formatting workflow and README documentation.
š Key Changes
Revised comments in the formatting workflow for clarity.
Updated the 'format' job to use a specific set of Ultralytics GitHub Actions:
Enforced Python code styling.
Ensured proper formatting for docstrings.
Formatted markdown documentation.
Added spelling checks.
Made aesthetic improvements to the README for better readability, such as adding extra line breaks.
šÆ Purpose & Impact
Clarity and Consistency: The workflow revision increases the clarity of the purpose of formatting and ensures code and documentation adhere to Ultralytics' standards.
Better Readability: Spacing in the README helps in distinguishing between different sections, making it easier for users to follow along.
Enhanced Quality Control: Including spelling checks and comprehensive formatting actions will help in maintaining high-quality documentation and codebase, which is beneficial for both contributors and users.
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
Enhancements to the automatic formatting workflow and README documentation.
š Key Changes
šÆ Purpose & Impact