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

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

Enhanced license formatting for improved clarity and consistency across the repo.

📊 Key Changes

  • Updated license headers in several files to a clearer and more standardized format.
  • Updated comments in format.yml, .pre-commit-hooks.yaml, and pyproject.toml files for consistency.

🎯 Purpose & Impact

  • 🧹 Improved consistency: Ensures that the license header is consistent across all files, making it easier to reference and understand.
  • 📜 Clarity: Directs users to the license link for more detailed information.
  • 🛠️ Minimal impact on functionality: No functional changes; this is purely an improvement in documentation and formatting for readability.

@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 a PR to ultralytics/pre-commit 🚀! To ensure a smooth integration of your contribution, please review the following guidelines:

  • Define a Purpose: Ensure your PR description clearly explains the intent of your changes. If applicable, link to any related issues to provide additional context. Commit messages should also be clear and follow our conventions.
  • Synchronize with Source: Make sure your PR is up-to-date with the latest ultralytics/pre-commit main branch. If necessary, synchronize your branch by clicking the 'Update branch' button or running git pull followed by git merge main locally.
  • Ensure CI Checks Pass: Check that all Continuous Integration (CI) systems pass successfully. Address any issues if they arise to ensure the PR is in a healthy state.
  • Update Documentation: If your PR includes changes requiring updated documentation, make sure to revise the relevant docs.
  • Add Tests: Add or update any necessary tests to verify your changes. Confirm that all tests complete successfully.
  • Sign the CLA: Please confirm that you’ve signed our Contributor License Agreement (CLA) by commenting "I have read the CLA Document and I sign the CLA" if this is your first contribution to Ultralytics.
  • Focus on Minimum Scope: Restrict your changes to the minimum scope needed for the update or fix. As Bruce Lee said, “Hack away the unessential.” 😄

For detailed guidance, refer to our Contributing Guide. Your PR title and description look informative, and the changes seem focused on improving license clarity and consistency—thank you for that! 🙌 However, if additional clarifications, tests, or updates are required from your end, we will let you know.

An Ultralytics engineer will review your PR soon and provide further feedback if needed. If you have any immediate questions, please feel free to ask here. Thanks again for your contribution to the Ultralytics community! 🌟

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

🎉 The PR is officially merged—thank you @pderrenger and @glenn-jocher for your collaborative efforts! 🙌 Your work to polish and standardize the license formatting across the repo adds a layer of clarity and professionalism that truly elevates our project.

As Leonardo da Vinci once said, "Simplicity is the ultimate sophistication." Your contributions may seem subtle, but their impact is profound—making it easier for others to engage, learn, and build confidently with Ultralytics. 🚀

Keep shining and innovating—we deeply appreciate your dedication! ✨

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