Skip to content

Standardize license headers in TOML/YAML files#124

Merged
pderrenger merged 1 commit intomainfrom
refactor-20250115173012
Jan 15, 2025
Merged

Standardize license headers in TOML/YAML files#124
pderrenger merged 1 commit intomainfrom
refactor-20250115173012

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

Improved consistency and clarity of license references in configuration and workflow files.

📊 Key Changes

  • Updated all license references to explicitly include the Ultralytics AGPL-3.0 License link (https://ultralytics.com/license).
  • Applied these updates across multiple key files: .dependabot.yml, workflow files (format.yml and publish.yml), and pyproject.toml.

🎯 Purpose & Impact

  • Clarity & Transparency: Ensures clear and consistent attribution to the Ultralytics AGPL-3.0 License across all configurations.
  • 🛡️ Legal Compliance: Reinforces proper licensing visibility, reducing any ambiguity for users or collaborators.
  • 🌍 Improved Accessibility: Makes it easier for users to locate and understand licensing terms directly from related files.

@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/mkdocs 🚀 PR! To ensure a seamless integration of your work, please review the following checklist:

  • Define a Purpose: Clearly explain the purpose of your fix or feature 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/mkdocs 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: Update the relevant documentation for any new or modified features.
  • Add Tests: If applicable, include or update tests to cover your changes, and confirm that all tests are passing.
  • Sign the CLA: Please ensure you have signed our Contributor License Agreement if this is your first Ultralytics PR by writing "I have read the CLA Document and I sign the CLA" in a new message.
  • Minimize Changes: Limit your changes to the minimum necessary for your bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." — Bruce Lee

For more guidance, please refer to our Contributing Guide. Don’t hesitate to leave a comment if you have any questions. Thank you for contributing to Ultralytics! 🚀

What's Next?

Your PR provides a scoped and useful change standardizing the license headers across repository metadata files. Clear and consistent licensing improves the professionalism and readability of the repository. 🙌

An Ultralytics engineer will review your submission shortly! If any adjustments are needed during review, one of our team members will reach out. Stay tuned, and thank you again for helping us improve. 🌟

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

🎉 Great news—this PR is officially merged! Huge thanks to @pderrenger for leading the way and to @glenn-jocher for your invaluable contributions. Your work refining license references brings clarity, transparency, and accessibility to our project, benefiting developers and collaborators around the globe. 🌍🔗

As Marcus Aurelius once said, "What we do now echoes in eternity." Your dedication to clarity and transparency resonates beyond code—fostering trust and understanding for all who engage with this repository. Thank you for making an impact! 💡🚀

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