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

Refined code formatting workflow and documentation updates for better clarity.

📊 Key Changes

  • Updated the GitHub Actions workflow to use the official Ultralytics formatting actions.
  • Enhanced the formatting workflow to include options for Python code, docstrings, markdown files, and spelling checks.
  • Cleaned up whitespace in the README and ensured proper listing for MATLAB toolboxes.

🎯 Purpose & Impact

  • 🛠️ Improved Maintenance: Adopting official Ultralytics formatting standards makes the codebase easier to maintain and contribute to.
  • 💻 Better Readability: Including docstrings, markdown, and spelling checks ensures high-quality documentation, improving the user experience.
  • 📝 Consistency: Auto-formatting enforces a consistent coding style, reducing friction for future collaborations.
  • 🗂️ Enhanced Documentation: The updates to the README provide clearer installation and setup instructions, benefiting new users.

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