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

Merged
merged 2 commits into from
Jan 1, 2024
Merged

Create format.yml #29

merged 2 commits into from
Jan 1, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jan 1, 2024

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Introducing an automated code and documentation formatting workflow, alongside plugin improvements for metadata enhancements and social sharing.

📊 Key Changes

  • Added a GitHub workflow (format.yml) for auto-formatting code and docs on push/PR events to the main branch.
  • Enhanced the MetaPlugin class to support additional metadata:
    • Now automatically adds descriptions, images, and author info from Git if not provided in Markdown headers.
    • Newly inserted meta tags for SEO and social sharing platforms like Twitter, Facebook, and LinkedIn.
    • Social sharing buttons (e.g., Twitter, LinkedIn) can be included in the footer.
  • Utility functions improved for YouTube video ID extraction and GitHub username retrieval from email, alongside several coding style adjustments.

🎯 Purpose & Impact

  • Ensure that all contributions are consistently formatted, reducing manual effort and improving code quality.
  • The metadata enhancements make documentation pages more informative and SEO-friendly. Social share buttons can boost user engagement and content reach.
  • Impact: Developers and users should see more polished and accessible content, potentially leading to better community contributions and wider dissemination of Ultralytics' projects. 📈🌐

@glenn-jocher glenn-jocher merged commit 7e9fabf into main Jan 1, 2024
1 check passed
@glenn-jocher glenn-jocher deleted the actions branch January 1, 2024 00:28
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