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

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

Updated workflow actions for improved code and documentation formatting, and refined README formatting for better clarity.

📊 Key Changes

  • Workflow actions now reference Ultralytics Actions directly, ensuring adherence to official Ultralytics standards.
  • Added specific formatting steps: Python, docstrings, markdown, and spelling checks to the workflow.
  • Streamlined texts and removed unnecessary whitespaces and line breaks in multiple README files.

🎯 Purpose & Impact

  • Ensures that all code contributions are automatically formatted to maintain a consistent and high-quality codebase. 🧹
  • Enhances readability and clarity of documentation, making it more accessible to users. 📖
  • Better documentation layout can attract and engage more users, improving their overall experience with Ultralytics projects. 🌐

@glenn-jocher glenn-jocher merged commit 6eff438 into main Jan 1, 2024
2 checks passed
@glenn-jocher glenn-jocher deleted the update-format-workflow-20240101224527 branch January 1, 2024 21:58
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