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

Merged
merged 2 commits 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 the formatting header in the GitHub Actions workflow file for improved clarity.

📊 Key Changes

  • Adjusted the comment format in .github/workflows/format.yml to make the license and its URL cleaner and more readable.

🎯 Purpose & Impact

  • 📖 Clarity: Makes the header easier to read and aligns with formatting best practices.
  • Standardization: Ensures comments are clean and professional, contributing to better project maintainability.

@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops documentation Improvements or additions to documentation labels Jan 15, 2025
@UltralyticsAssistant
Copy link
Member

👋 Hello @pderrenger, thank you for submitting an ultralytics/flickr_scraper 🚀 PR! To ensure a seamless integration of your work, please review the following checklist:

  • Define a Purpose: Clearly explain the purpose of your changes in your PR description, and link to any relevant issues. Ensure your commit messages are clear, concise, and adhere to the project's conventions.
  • Synchronize with Source: Confirm your PR is synchronized with the ultralytics/flickr_scraper main branch. If it's behind, update it by clicking the 'Update branch' button or by running git pull and git merge main locally.
  • Ensure CI Checks Pass: Verify all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address the issues.
  • Update Documentation: Ensure any new or modified features are documented in the relevant repository documentation.
  • Add Tests: If applicable, include or update tests to verify your changes, and confirm that all tests pass successfully.
  • Sign the CLA: Don’t forget to sign our Contributor License Agreement (CLA) if this is your first time contributing by adding “I have read the CLA Document and I sign the CLA” in a new comment.
  • Minimize Changes: Restrict your changes to the minimum required for your fix or feature. "It is not daily increase but daily decrease, hack away the unessential."

For more information, check out our Contributing Guide. If your PR addresses a bug or issue, please include a Minimum Reproducible Example (MRE) to help us test and validate your work. 🚀

Thank you for your contribution; an Ultralytics engineer will review your PR soon. If you have any questions in the meantime, feel free to ask. 🙌

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

🎉 The PR is merged! Huge thanks to @pderrenger for leading the charge and @glenn-jocher for the collaboration. 🚀 Your updates to the workflow header aren’t just a formatting tweak—they're a step toward clarity and excellence, making the project more welcoming and robust for everyone. 💡

As Leonardo da Vinci once said, "Simplicity is the ultimate sophistication." Your efforts embody this wisdom, proving that even small, thoughtful changes can resonate with impact. 🙌 Thank you for making the project better, one clean line at a time! ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops GitHub Devops or MLops documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants