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

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

Improvement of documentation formatting and guidelines for Ultralytics docs.

📊 Key Changes

  • Updated the .github/workflows/format.yml to reference official Ultralytics formatting standards.
  • Extended the formatting action to include checks for Python code, docstrings, markdown, and spelling.
  • Corrected whitespace and indentation inconsistencies in the README.md.
  • Replaced bullet points with asterisks (*) in the GitHub Pages Deployment section for consistency.
  • Minor formatting changes for clarity in multi-language documentation instructions and GitHub Pages Deployment Example.

🎯 Purpose & Impact

  • Ensures that the code and documents across PRs adhere to the official Ultralytics style guide 📏, promoting consistency and readability.
  • Extended checks help maintain high-quality documentation 📝 and code, improving the user experience for both developers and non-technical users.
  • Formatting changes in README.md ensure that instructions are more user-friendly and accessible 🌐, making it easier to install and contribute to Ultralytics projects.
  • Could potentially reduce the number of manual review cycles for code style issues 🔄, allowing maintainers to focus on content and quality.

@glenn-jocher glenn-jocher merged commit 6d67089 into main Jan 1, 2024
@glenn-jocher glenn-jocher deleted the update-format-workflow-20240101224605 branch January 1, 2024 22:01
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