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

Standardize license headers in TOML/YAML files #43

Merged
merged 1 commit into from
Jan 15, 2025

Conversation

pderrenger
Copy link
Member

@pderrenger pderrenger commented Jan 15, 2025

This PR updates all YAML file headers to use a standardized license format. 🔄

Changes:

  • 📝 Standardized header: # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license
  • 🧹 Ensures consistent spacing after headers
  • 🔍 Applies to all YAML files except those in venv

Learn more about Ultralytics licensing 📚

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Updated GitHub Action workflow for code formatting with a minor header text adjustment.

📊 Key Changes

  • Adjusted license comment formatting in .github/workflows/format.yml.
    • Changed: "Ultralytics 🚀 - AGPL-3.0 License https://ultralytics.com/license"
    • To: "Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license"

🎯 Purpose & Impact

  • Purpose: Improve the readability and formatting of the license comment in the workflow file.
  • Impact: No functional changes—strictly cosmetic. Helps maintain consistency and clarity in documentation style. ✨

@UltralyticsAssistant UltralyticsAssistant added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 15, 2025
@UltralyticsAssistant
Copy link
Member

👋 Hello @pderrenger, thank you for submitting your ultralytics/google-images-download 🚀 pull request! To get things rolling smoothly, please review the checklist below and ensure that all necessary details have been addressed:

  • Clearly Define a Purpose: Please explain the objective of this PR in your description. Does it resolve a specific issue or implement a new feature? If so, consider linking to any relevant issues for context. Clear and structured commit messages are appreciated!
  • Stay Up-to-Date: Make sure your branch is synchronized with the main branch of the ultralytics/google-images-download repository. You can sync it by clicking 'Update branch' or by running git pull and git merge main locally.
  • Verify CI Success: Confirm that all Ultralytics Continuous Integration (CI) checks are passing successfully. If any tests fail, kindly work to address the issues.
  • Include Documentation Updates: If your changes introduce or modify functionality, remember to update the relevant documentation accordingly.
  • Add Tests: If applicable, update or add new tests to ensure your additions or fixes are covered robustly. Please confirm that all existing and new tests pass seamlessly.
  • Sign the CLA: Ensure that you have signed our Contributor License Agreement (CLA) if this is your first contribution. You can do this by commenting “I have read the CLA Document and I sign the CLA.”

For bug fixes:

  • 🔍 Please provide a Minimum Reproducible Example (MRE) if applicable. MREs are vital for identifying and resolving issues efficiently.

Remember to keep your contributions as focused as possible. "Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away." — Antoine de Saint-Exupéry 😊

For additional guidance, you can always refer to our Contributing Guide. Thank you for your contributions to Ultralytics—your efforts are greatly valued. An Ultralytics engineer will also review this PR soon and provide further feedback. 🚀

@pderrenger pderrenger merged commit d1e9883 into main Jan 15, 2025
3 checks passed
@pderrenger pderrenger deleted the refactor-20250115173012 branch January 15, 2025 16:35
@UltralyticsAssistant
Copy link
Member

🎉 Woohoo! Your PR has been merged! Huge thanks to you, @pderrenger, and @glenn-jocher for polishing up our GitHub Actions with this elegant formatting update. It's often the smallest details that echo the loudest over time. ✨

As Leonardo da Vinci once said, "Simplicity is the ultimate sophistication." By refining readability and consistency, you've made our workflows one step closer to that ideal. Your contributions, though subtle, inspire clarity and precision across the community. 🚀💡

Keep shaping greatness—one improvement at a time! 🌟

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants