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

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

Updated license header comments across GitHub workflow files for clarity and consistency.

📊 Key Changes

  • Adjusted license headers in multiple .yml files to include a standardized format:
    "Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license".
  • Applies to files managing workflows like domain checks, link validation, site maps, formatting, etc.

🎯 Purpose & Impact

  • Enhanced Clarity: Provides a clear reference to the license and its URL for transparency 🎯.
  • Consistency: Streamlines documentation and ensures all workflows reflect the same licensing information ✅.
  • No Functional Impact: Changes are documentation-related and do not alter any workflow operations 🚀.

Copy link

vercel bot commented Jan 15, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 15, 2025 4:35pm

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

  • Define a Purpose: Make sure the PR description clearly explains its purpose and impact. If applicable, link to any related issues for better context. Please ensure your commit messages are descriptive and follow best practices.
  • Synchronize with Source: Confirm that your branch is up-to-date with the main branch of ultralytics/docs. If it’s not, update it by running git pull and resolving any conflicts, or by clicking the 'Update Branch' button directly in the PR.
  • Ensure CI Checks Pass: All Continuous Integration (CI) checks must pass. If there are any failures, kindly review the error logs and address them before resubmitting.
  • Update Documentation: If your changes affect the documentation, please ensure you have updated the relevant docs files to reflect the new information.
  • Add Tests: If your changes include new functionality or modify existing code, ensure that tests have been added or updated. Validate that all tests pass successfully before finalizing your PR.
  • Sign the CLA: If you haven’t already done so, please sign the Contributor License Agreement (CLA). You can complete this by commenting "I have read the CLA Document and I sign the CLA" in your PR thread.
  • Minimize Changes: Try to limit changes in the PR to only what is strictly necessary to achieve its goal. This reduces potential conflicts and improves reviewability. As Bruce Lee aptly put it, "Hack away the unessential." 💡

Additionally, for further clarification or guidance, please refer to our detailed Contributing Guide.

Your PR Summary:

This PR focuses on standardizing license headers across configuration files such as .yml and .toml to a consistent format. 🛠️ The new header improves clarity and aids in compliance with Ultralytics' licensing practices.

Key Updates:

  • Standardized license headers: # Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license
  • Applied to various files, including but not limited to:
    • .github/dependabot.yml
    • .github/workflows/check_domains.yml
    • .github/workflows/download_websites.yml
    • .github/workflows/tag.yml
  • Enhanced codebase consistency by ensuring uniform formatting throughout ⚡.

Impact:

  • Transparency: Users and contributors will benefit from a clear and standardized license reference in every relevant file.
  • Consistency: Enhances the readability and professionalism of Ultralytics repositories.
  • Compliance: Clarifies legal obligations and licensing terms for existing and future adopters of Ultralytics content.

This is an automated response 🤖, but rest assured, an Ultralytics engineer will review your submission and provide additional feedback soon. Feel free to reach out with any further questions or comments. Thank you for your dedication and contributions to the Ultralytics community! 🌟

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

🎉 Amazing news, team! The PR by @pderrenger, with contributions from @glenn-jocher, is officially merged! 🚀

Your efforts to enhance clarity and consistency in our license headers are deeply appreciated—seemingly small yet profoundly impactful changes like these help solidify the foundation for transparency and collaboration. ❤️

As Marcus Aurelius once wrote, "What we do now echoes in eternity." Your thoughtful contributions ensure that our workflows remain clear and respectful of the open-source ethos, resonating with every future coder who encounters them.

Thank you for making a difference. Here's to pushing boundaries together! 🌟

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