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

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

Introducing automated code and documentation formatting for Ultralytics contributions. 🛠️

📊 Key Changes

  • Added a new GitHub Actions workflow (format.yml) to automate code formatting.
  • Simplified the Contributor License Agreement (CLA) document for clarity and readability.
  • Made minor updates to the README.md to improve presentation.

🎯 Purpose & Impact

  • Workflow Automation: Ensures all code and documentation adhere to Ultralytics' standards automatically upon push to main/master or when a pull request is made. 🤖
  • CLA Simplification: Streamlines the agreement to make it easier for contributors to understand the terms under which they contribute. 📜
  • Improved Transparency: Clean and clear documentation can bolster community trust and contribution quality. 💡

The changes aim to streamline the contribution process, reduce manual effort, and maintain high-quality code and documentation standards, leading to a more robust and developer-friendly environment.

@glenn-jocher glenn-jocher merged commit 0eb5032 into main Jan 1, 2024
@glenn-jocher glenn-jocher deleted the update-format-workflow-20240101224542 branch January 1, 2024 22:00
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