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

Merged
merged 4 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

Implementation of automatic code formatting and streamlining of community engagement.

📊 Key Changes

  • Added format.yml workflow for automatic code and documentation formatting.
  • Simplified the language in the Code of Conduct for clarity.
  • Updated the Pull Request Template to encourage better PR descriptions.
  • Minor adjustments in README files for consistency.

🎯 Purpose & Impact

  • 🛠️ The new GitHub Actions workflow ensures consistent code quality and adherence to standards.
  • 📜 Revised Code of Conduct terms should be easier to read and follow.
  • 🤝 PR templates changes aim for better communication and faster PR reviews.
  • ✨ README updates provide a tidier and more welcoming landing experience for visitors.

@glenn-jocher glenn-jocher merged commit 3577acf into master Jan 1, 2024
1 check passed
@glenn-jocher glenn-jocher deleted the update-format-workflow-20240101224520 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