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

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

Update to GitHub issue templates and code formatting workflow, plus minor README enhancements.

📊 Key Changes

  • 🐛 Bug report and 🚀 Feature request templates in .github/ISSUE_TEMPLATE were simplified and redundant text was removed.
  • format.yml workflow now supports additional branches and includes more automatic formatting checks.
  • README instructions are slightly restructured for clarity.

🎯 Purpose & Impact

  • 🛠️ Simplifying issue templates aims to make it easier for users to create bug reports and feature requests.
  • 🎨 Enhanced code formatting workflow ensures consistent code quality and styling across more branches.
  • 📖 Improved README contributes to better user understanding of setup and training processes.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @UltralyticsAssistant, thank you for submitting a PR! We will respond as soon as possible.

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