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

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

Enhanced formatting automation for Ultralytics GitHub repositories.

📊 Key Changes

  • 🔄 Updated workflow with a more descriptive title and link to Ultralytics Actions.
  • ✅ Added new workflow steps to enable automated formatting checks for Python code, documentation strings, markdown files, and spelling errors.

🎯 Purpose & Impact

  • 📈 Ensures consistent code and documentation formatting according to Ultralytics standards.
  • ✨ Improves the readability and maintainability of the codebase, benefiting both contributors and users.
  • 🔍 Helps maintain a high level of code quality through automated reviews, potentially reducing the number of manual review cycles.
  • 🛠️ Streamlines the contribution process by automatically checking for common formatting issues.

@glenn-jocher glenn-jocher merged commit 72a7d24 into master Jan 1, 2024
@glenn-jocher glenn-jocher deleted the update-format-workflow-20240101224214 branch January 1, 2024 21:46
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.

None yet

2 participants