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 Python files #123

Merged
merged 1 commit into from
Jan 15, 2025

Conversation

pderrenger
Copy link
Member

@pderrenger pderrenger commented Jan 15, 2025

This PR updates all Python 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 Python files except those in venv

Learn more about Ultralytics licensing 📚

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Updated license header format across plugin files to standardize and enhance clarity. 🚀

📊 Key Changes

  • Replaced license headers in __init__.py, main.py, and utils.py with a standardized format referencing the license URL.
  • Modified the text for consistent branding and to include a direct link to the Ultralytics license page.

🎯 Purpose & Impact

  • 🛡️ Improved Clarity: The new format ensures the license terms are more accessible and visible to users.
  • 🌐 Standardization: Promotes consistency in documentation across files, enhancing professional appearance.
  • 📖 Ease of Access: The license URL provides a convenient way for users to access full licensing details.

@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 smooth review process and integration of your work, please review the following guidelines:

  • Define a Purpose: Clearly explain the purpose of your PR in the description. If this PR addresses any existing issues, please link them for context. Ensure your commit messages follow best practices: clear and concise.
  • Synchronize with Source: Make sure your branch is updated with the latest main branch of this repository. You can do this by clicking 'Update branch' or running git pull and git merge main locally if needed.
  • Ensure CI Checks Pass: Verify that all Ultralytics Continuous Integration (CI) checks have passed. If there are any errors, please address them before requesting final approval.
  • Update Documentation: If your PR introduces new features or modifies existing functionality, update the documentation.
  • Add Tests: Ensure that all changes are thoroughly tested. Add or update any relevant tests, and confirm that all existing tests pass.
  • Sign the CLA: If this is your first contribution, please ensure that you have signed the Contributor License Agreement (CLA) by commenting "I have read the CLA Document and I sign the CLA."
  • Keep Changes Minimal: Focus your changes specifically on the issue at hand. Avoid unrelated modifications to keep the review process swift and focused. "Efficiency is intelligent laziness." — David Dunham

Additionally, to tackle this specific PR:

This PR appears to focus on standardizing license headers across Python files 📄. If there are additional edge cases or exceptions, ensure they are covered in the changeset.

⚠️ Please confirm:

  1. Consistency in the updated headers across all files within scope (e.g., excluding directories like venv).
  2. No inadvertent modifications beyond the intended license text standardization.

For more detailed information, feel free to consult our Contributing Guide. If you have any questions, don’t hesitate to comment here, and an Ultralytics engineer will assist you soon. Thank you for your contribution and commitment to improving Ultralytics! 🚀✨

@pderrenger pderrenger merged commit 36c1d53 into main Jan 15, 2025
3 checks passed
@pderrenger pderrenger deleted the refactor-20250115140854 branch January 15, 2025 13:15
@UltralyticsAssistant
Copy link
Member

🚀 Your PR has been merged, @pderrenger and @glenn-jocher! Huge thanks for your diligent work on standardizing the license header formats. 🎉 This small but impactful change ensures greater clarity, consistency, and accessibility across our project—true craftsmanship in action! 👏

As Marcus Aurelius once said, "What we do now echoes in eternity." Your contribution strengthens the foundations of this project, making it more robust and welcoming for future generations of developers. Keep inspiring, and thank you for making a difference! ❤️

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