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

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

This PR standardizes license headers across configuration, issue templates, workflows, and example dataset files, explicitly linking to the Ultralytics AGPL-3.0 license.

📊 Key Changes

  • Added a consistent license header (Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license) to:
    • GitHub issue templates (bug-report, feature-request, question, etc.).
    • Workflow files (CI, CLA, format, etc.).
    • Example dataset YAML files (e.g., coco8.yaml, dota8.yaml).
  • Replaced outdated or inconsistent license references with the new standard format.

🎯 Purpose & Impact

  • Purpose:

    • Ensure clarity and consistency by including explicit license information across all relevant project files.
    • Align with best practices for open-source licensing transparency.
  • Impact:

    • Boosts trust and understanding for users and contributors regarding licensing terms.
    • Encourages compliance with the AGPL-3.0 license through better documentation.
    • No functional changes to code or workflows, hence no direct impact on end-user operations.

@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 your ultralytics/hub 🚀 PR! To ensure a smooth review and integration process, please take a moment to go through the checklist below:

  • Purpose Defined: Clearly articulate the purpose of your PR and reference any relevant issues if applicable. Commit messages should remain clear, concise, and aligned with project conventions.
  • Stay Synced: Ensure your branch is up-to-date with the main branch of ultralytics/hub. You can achieve this via the 'Update branch' button on GitHub or by running git pull and git merge main locally.
  • Run CI Checks: Please confirm all Ultralytics Continuous Integration (CI) checks pass. Address any failing checks proactively to avoid delays.
  • Documentation Updates: Update corresponding documentation if your proposed changes introduce new features, behaviors, or modifications.
  • Testing: If applicable, include new tests or update existing ones to cover your changes. Confirm successful test execution locally and within the CI pipeline.
  • Contributor License Agreement (CLA): If this is your first PR to Ultralytics, please sign our Contributor License Agreement by commenting "I have read the CLA Document and I sign the CLA" to comply with our contribution policy.
  • Minimize Changes: Keep your changes focused and to the minimum required for your objectives. Per the wise words of Bruce Lee: "Hack away the unessential." 🥋

We noticed this PR introduces standardized license headers across multiple files. This is a fantastic step towards greater consistency! 🎉 A few reminders and clarifications as we proceed:

  • Confirm that no license changes unintentionally impact logic, functionality, or workflows.
  • If this addresses a specific licensing requirement or policy update, please share any details or context to ensure proper review.

For further tips on contributing, take a look at our Contributing Guide. An Ultralytics engineer will review your PR soon, but in the meantime, please let us know if you have any questions or comments. Thanks for helping us improve Ultralytics! 🚀💡

@glenn-jocher glenn-jocher merged commit c07792c into main Jan 15, 2025
3 checks passed
@glenn-jocher glenn-jocher deleted the refactor-20250115173012 branch January 15, 2025 16:50
@UltralyticsAssistant
Copy link
Member

🎉 Woohoo! The PR has been merged—huge thanks to @pderrenger for leading this effort and @glenn-jocher for supporting with insights! 🛠️ Your work to standardize and clarify license headers ensures transparency and aligns our project with open-source best practices. 🚀

As Marcus Aurelius once said, "What we do now echoes in eternity." Your contributions will echo through our community, empowering users and future contributors with clarity and trust. Together, we’re making open-source better, one thoughtful detail at a time. 💡❤️

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