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

Add Prettier for YAML formatting to Ultralytics Actions #705

Merged
merged 1 commit into from
May 30, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented May 30, 2024

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Enhanced code formatting and validation in GitHub workflows.

πŸ“Š Key Changes

  • Split Markdown and YAML formatting responsibilities: Markdown continues to be formatted directly, while YAML formatting now uses the prettier tool.
  • Maintained Python code formatting and docstring adjustments, as well as spell checking and broken link detection.
  • Ensured the PR summary generation feature remains, powered by GPT-4, requiring specific API keys.

🎯 Purpose & Impact

  • Improves code consistency: By using specialized tools for Markdown and YAML, the project ensures higher code and documentation quality.
  • Enhances developer experience: Streamlines the contribution process, making it easier for developers to adhere to project standards.
  • Automates quality checks: Helps in catching potential issues early, such as spelling errors or dead links, improving the overall robustness of the documentation.
  • Facilitates PR reviews: The automated PR summaries provide a quick overview, helping maintainers to understand changes faster.

This update aims to refine the development workflow, making it more efficient and less error-prone, which benefits both project maintainers and contributors. πŸ› οΈβœ¨

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

@glenn-jocher glenn-jocher merged commit 57d25b3 into main May 30, 2024
3 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch May 30, 2024 10:37
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