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

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 license references across various files for consistency and clarity.

📊 Key Changes

  • Replaced the old license comment # Ultralytics YOLOv3 🚀, AGPL-3.0 license with the updated format:
    # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license.
  • Cleaned or clarified license references in issues templates, continuous integration (CI) workflows, data configuration files, model configuration files, and other project files.

🎯 Purpose & Impact

  • 📝 Consistency: Ensures all files reflect the same format for the project's license reference.
  • 🔗 Clarity: Includes a direct, visible link to the license details.
  • Enhanced Communication: Better visibility and understanding of licensing terms, benefiting both contributors and users.
  • 🚀 Impact: No functional changes to the code; purely cosmetic for ease of maintainability and compliance clarity.

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

👋 Hello @pderrenger, thank you for submitting your ultralytics/yolov3 🚀 PR! To ensure a smooth and efficient review process, please review the checklist below:

  • Define a Purpose: Clearly outline the purpose of your PR and include any relevant details or references to related issues. For example, clarify why standardizing the license headers improves the project.
  • Synchronize with main: Please make sure your branch is updated with the latest changes from the main branch. You can do this by clicking the 'Update branch' button if available or by running git pull and git merge main locally.
  • Pass CI/CD Checks: Ensure that all Continuous Integration checks pass successfully. Address any issues flagged in the CI.
  • Update Documentation: Include relevant updates in the documentation that might be affected by or explain this PR.
  • Testing the Updates: If applicable, include or run tests to validate that the changes are functional and do not introduce regressions.
  • Sign the Contributor License Agreement (CLA): If this is your first contribution, please ensure you’ve signed our CLA by commenting "I have read the CLA Document and I sign the CLA" on this PR.
  • Review PR Size: Limit your changes to those critical to your PR's purpose. Avoid unrelated modifications to keep the review process focused and straightforward.

Licensing Standardization 🌟

Your proposed changes reflect valuable updates to ensure consistent license references across all configuration and YAML files. We appreciate your effort to improve project transparency and documentation consistency! 👍

If you’ve encountered issues or challenges during this update, feel free to include additional notes for context or to reference specific files. If there are bugs or conflicts arising from this, providing a minimum reproducible example (MRE) or additional details will help us assist you faster.

For further contributing guidelines, take a look at our Contributing Guide. Please let us know if you have any questions, and an Ultralytics engineer will assist as soon as possible. Thank you for your contribution to Ultralytics! 🚀

@glenn-jocher glenn-jocher merged commit 239aaaf into master Jan 15, 2025
9 checks passed
@glenn-jocher glenn-jocher deleted the refactor-20250115173012 branch January 15, 2025 16:52
@UltralyticsAssistant
Copy link
Member

🎉 This PR is officially merged! Huge thanks to @pderrenger for leading this update and to @glenn-jocher for contributing your expertise. 🌟 Your work in refining and clarifying license references speaks volumes about the importance of consistency and transparency for the community.

As Marcus Aurelius once said, "What we do now echoes in eternity." By aligning and clarifying these details, you've not only improved the project today but have set a standard that will resonate with contributors and users far into the future. 🚀

Your effort is deeply appreciated—thank you for making Ultralytics better with every PR! ❤️

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