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

Create format.yml #2165

Merged
merged 8 commits into from
Jan 3, 2024
Merged

Create format.yml #2165

merged 8 commits into from
Jan 3, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jan 2, 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

WARNING ⚠️ this PR is very large, summary may not cover all changes.

🌟 Summary

Streamlined GitHub Actions YAML configuration and CONTRIBUTING.md updates

📊 Key Changes

  • Added an automated workflow format.yml for code formatting.
  • Reduced clutter in CONTRIBUTING.md, improving readability.
  • Modified benchmarks.py, classify/predict.py, classify/train.py, README.md, README.zh-CN.md and other files for minor improvements and code clean-up.
  • Introduced .github/workflows/format.yml for enforcing style guidelines.

🎯 Purpose & Impact

  • 🧹 Maintains consistent code formatting automatically, ensuring code quality.
  • 📖 Simplifies contribution documentation, making it easier to contribute.
  • ✨ Provides general codebase cleanup, resulting in cleaner, more maintainable code.
  • 🚀 Automates formatting tasks, potentially increasing the productivity of developers.

@glenn-jocher glenn-jocher merged commit cac7189 into master Jan 3, 2024
7 checks passed
@glenn-jocher glenn-jocher deleted the format_yaml branch January 3, 2024 07:04
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.

1 participant