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

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 GitHub workflow files to align with Ultralytics' licensing and documentation standards. 📋✨

📊 Key Changes

  • Adjusted license comments for better clarity and consistency in format.yml and test.yml.

🎯 Purpose & Impact

  • ✅ Improved clarity by standardizing license and documentation notations.
  • 🍀 Enhances readability and alignment with Ultralytics' branding, ensuring compliance and professional presentation.

@UltralyticsAssistant UltralyticsAssistant added the documentation Improvements or additions to documentation label Jan 15, 2025
@UltralyticsAssistant
Copy link
Member

👋 Hello @pderrenger, thank you for submitting an ultralytics/CLIP 🚀 PR! To ensure a seamless review and integration of your contributions, please take the following steps:

  • Provide Context & Purpose: Please include a clear description of the purpose of your PR in its description. For any linked issues, ensuring full visibility into the impact of your changes helps tremendously.
  • Keep Code Up-to-Date: Ensure that your branch is in sync with the latest main branch by using the 'Update branch' button on GitHub or by running git pull and git merge main locally. Conflicts should be resolved before the review.
  • Pass All CI Checks: Confirm that all Ultralytics Continuous Integration (CI) checks are passing. If there are failures, address these as part of the PR's scope.
  • Add Relevant Tests: Whenever applicable, include or modify tests to ensure your changes are robust and reliable. Confirm that all tests pass locally before submission.
  • Sign the CLA: If this is your first PR with Ultralytics, kindly review and sign our Contributor License Agreement (CLA) by commenting "I have read the CLA Document and I sign the CLA" on this PR.
  • Minimize Changes to the Essentials: Only include changes essential to your PR's intent. Extraneous or unrelated modifications can make the review more challenging.

🔍 If this PR addresses a bug, please provide a minimum reproducible example (MRE). An MRE ensures others can understand and verify the fix more efficiently. You can attach code snippets, dataset samples, or other relevant details if applicable.

For additional details, please consult our Contributing Guide. Questions or issues? Feel free to comment directly here, and one of our engineers will assist soon. 🤝

Thank you for your contribution to the Ultralytics ecosystem! 🚀

@pderrenger pderrenger merged commit 092b5fe into main Jan 15, 2025
5 checks passed
@pderrenger pderrenger deleted the refactor-20250115173012 branch January 15, 2025 16:38
@UltralyticsAssistant
Copy link
Member

🎉 Great news! This PR is officially merged! Huge thanks to @pderrenger for championing this update and to @glenn-jocher for the valuable contributions. 🙌 Your efforts in refining our GitHub workflows and aligning them with Ultralytics' standards not only improve clarity but also set the stage for future excellence. 📋✨

As Leonardo da Vinci once said, "Details make perfection, and perfection is no detail." Your attention to detail has elevated our work, ensuring precision and professionalism. Thank you for making a difference—your contribution inspires progress! 🚀

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants