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 #5

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

Implementing automated code and documentation formatting in Ultralytics repositories.

📊 Key Changes

  • A new GitHub Actions workflow (format.yml) has been added.
  • The workflow triggers on pushes and pull requests to the main or master branches.
  • It includes steps for formatting Python code, docstrings, markdown files, and spelling checks.

🎯 Purpose & Impact

  • Purpose: To ensure consistency and adherence to Ultralytics' standards across code and documentation.
  • Impact: Contributors will experience an automated process that ensures their submissions are properly formatted, reducing manual review time and improving overall codebase quality. 🔄📝

🔄 Automated formatting can also potentially reduce merge conflicts and make the development process smoother for everyone involved.

@glenn-jocher glenn-jocher merged commit 4b811ad into main Jan 1, 2024
@glenn-jocher glenn-jocher deleted the update-format-workflow-20240101224557 branch January 1, 2024 22:01
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