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

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 automatic code and documentation formatting in Ultralytics' GitHub workflows.

πŸ“Š Key Changes

  • Updated workflow comments to reference Ultralytics Actions.
  • Workflow now explicitly defines the formatting options: Python code, docstrings, markdown files, and spelling checks.
  • Reduced the space used in the README by placing two images on the same line.

🎯 Purpose & Impact

  • 🎨 Encourages consistent code and documentation style across Ultralytics' PRs.
  • 🐍 Ensures Python codes, docstrings, markdown, and spelling are all automatically checked, reducing the chance of manual formatting errors.
  • πŸ“š Improves the README layout, making it more compact and visually appealing.

@glenn-jocher glenn-jocher merged commit cc50906 into master Jan 1, 2024
@glenn-jocher glenn-jocher deleted the update-format-workflow-20240101224222 branch January 1, 2024 21:47
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