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

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 GitHub Actions for code formatting and enhanced Magellan README guidelines.

📊 Key Changes

  • ✨ Replaced the old format workflow with the new Ultralytics Actions for automated code and documentation formatting.
  • 👩‍💻 Expanded the formatting actions to include Python, docstrings, markdown files, and spelling checks.
  • 📝 Added spacing in the README for better readability and structure around installation requirements.

🎯 Purpose & Impact

  • ⚙️ The updated workflow helps ensure all PRs meet Ultralytics' coding and documentation standards automatically, saving time and improving code quality.
  • 📚 More comprehensive checks in the formatting process can lead to cleaner, more maintainable, and professionally presented code and docstrings.
  • 🔎 Enhanced README guidance aids in user comprehension, promoting a smoother setup experience for new users of the Magellan project.

@glenn-jocher glenn-jocher merged commit 6454f40 into master Jan 1, 2024
@glenn-jocher glenn-jocher deleted the update-format-workflow-20240101224237 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