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 formatting actions and streamlined documentation in the NUDAR project repository.

📊 Key Changes

  • 🔄 Replaced the original formatting workflow with Ultralytics' official formatting standards link.
  • 🚀 Enhanced the code formatting action to include checks for Python code, docstrings, markdown, and spelling.
  • ✂️ Removed redundant information from the README and improved link formatting for a cleaner presentation.
  • 🧹 Minor cosmetic text adjustments in the README for improved readability.

🎯 Purpose & Impact

  • 🎨 Ensures that all contributions to the NUDAR project follow a consistent coding style, leading to better code quality and maintainability.
  • 📝 Enhances the readability of the documentation, making it more accessible and user-friendly for both new and existing users.
  • 🛠 Potentially reduces the time maintainers need to spend on formatting and reviewing documentation changes.
  • 🌐 Provides users with a more streamlined experience when navigating and understanding the project through the README.

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