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 format.yml #18

Merged
merged 2 commits into from
Jan 1, 2024
Merged

Conversation

UltralyticsAssistant
Copy link
Member

@UltralyticsAssistant UltralyticsAssistant commented Jan 1, 2024

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.

name: Ultralytics Actions

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  format:
    runs-on: ubuntu-latest
    steps:
      - name: Run Ultralytics Formatting
        uses: ultralytics/actions@main
        with:
          python: true
          docstrings: true
          markdown: true
          spelling: true

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

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.

@glenn-jocher glenn-jocher merged commit 8f06901 into master Jan 1, 2024
1 check passed
@glenn-jocher glenn-jocher deleted the update-format-workflow-20240101224449 branch January 1, 2024 21:53
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