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

Merged
merged 2 commits 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

This PR updates license references across multiple files to include an explicit link to the Ultralytics license page for better transparency and accessibility.

📊 Key Changes

  • Replaced header comments in all files to specify the Ultralytics AGPL-3.0 license with a direct link (https://ultralytics.com/license).
  • Updated ClearML's about link to point to its new GitHub repository (https://github.com/clearml/clearml).

🎯 Purpose & Impact

  • Improved Clarity: Ensures all code files clearly reference the software license and provide users with direct access to license details. 📄
  • Transparency: Enhances legal compliance by making license information more explicit, aiding both developers and end users. 🌐
  • Better Documentation: Updates ClearML integration links to the correct repository for ease of use. 🚀

This has no functional impact on model behavior but reflects best practices and simplifies license attribution for users.

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

👋 Hello @pderrenger, thank you for submitting a yolov3 🚀 PR! To ensure a smooth review and integration process, please take a moment to review the following checklist and helpful resources:

  • Define a Purpose: Clearly explain the purpose and impact of your PR in its description. Link to any relevant issues if applicable. Make sure your commit messages are clear and conform to the project's conventions.
  • Synchronize with Source: Ensure your PR is synchronized with the latest main branch of the yolov3 repository. If it is outdated, you can update it by clicking the 'Update branch' button or by running git pull and git merge locally.
  • Pass CI Checks: All Ultralytics Continuous Integration (CI) checks should pass. Address any failing checks to proceed with the PR.
  • Update Documentation: Verify that relevant parts of the documentation are updated to reflect changes introduced by your PR.
  • Provide Tests: If applicable, include or modify tests to cover your changes. Confirm that all existing and new tests pass successfully.
  • Sign the CLA: If this is your first contribution to Ultralytics, ensure that you've signed our Contributor License Agreement (CLA) by commenting the following on the PR: "I have read the CLA Document and I sign the CLA."
  • Keep Changes Minimal: Limit the changes introduced in the PR to the minimum essential to implement the feature or fix the issue. Simplicity and clarity improve maintainability! 🛠️

PR Details:

Your PR titled "Standardize license headers in Python files" focuses on updating Python source file headers to a standardized license format. 👍

Changes Introduced:

  • Standardized header format: # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license
  • Consistent spacing after headers for better structure 💡
  • Coverage applied to all Python files except those in the venv folder.

Impact:

This change improves legal clarity and ensures consistent file headers across the project, aligning with YOLOv3's licensing policies without affecting core functionality.

🛠️ Next Steps:
If applicable, please ensure that:

  1. All CI checks pass on this PR.
  2. There's no unintended modification to non-relevant files.
  3. Proper attribution for contributions is included if other collaborators are involved.

For detailed contribution guidelines, refer to our Contributing Guide 📝.


⚡ Please note, this is an automated response to guide you through the process. An Ultralytics engineer will review your pull request shortly and provide further feedback if necessary. If you have any questions or need assistance, feel free to leave a comment below. Thank you for helping improve Ultralytics YOLOv3! 🚀✨

@glenn-jocher glenn-jocher merged commit 7beeb1f into master Jan 15, 2025
9 checks passed
@glenn-jocher glenn-jocher deleted the refactor-20250115140854 branch January 15, 2025 14:25
@UltralyticsAssistant
Copy link
Member

🎉 The PR is merged—thank you, @pderrenger, with contributions from @glenn-jocher, for your thoughtful work! Your efforts to enhance transparency and clarity in our license references and documentation are deeply valued. 🌟

As Marcus Aurelius once said, “What we do now echoes in eternity.” By prioritizing open communication and accessibility, you contribute to a foundation that inspires trust and empowers users. This update is a testament to the power of collaboration and attention to detail. 🚀

We’re excited about the positive impact this will have—cheers to 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