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

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

Minor updates to standardize license headers across workflow and configuration files. 📄✨

📊 Key Changes

  • Reworded and standardized license headers in ci.yml, format.yml, and pyproject.toml to include consistent formatting and links to the license.

🎯 Purpose & Impact

  • 📑 Purpose: Ensures uniformity and professionalism in documentation by aligning header text and providing clear access to the license URL.
  • 🚀 Impact: Improves clarity for developers and contributors, making it easier to access licensing details directly from the files. No functional changes to the project.

@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 an ultralytics/template 🚀 PR! To ensure a smooth review process for your contribution, please review the following checklist:

  • Define a Purpose: Make sure your PR description clearly outlines its purpose. For example, provide details about the issue it resolves or the features it enhances. If applicable, link to any relevant issues. Commit messages should be clear and adhere to our conventions.
  • Synchronize with Source: Verify that your PR is up-to-date with the main branch of ultralytics/template. If it isn't, please update it by clicking 'Update branch' or run git pull and git merge main locally.
  • Ensure CI Checks Pass: Confirm that all Continuous Integration (CI) checks pass without errors. If any checks fail, please address them to ensure a successful review.
  • Update Documentation: Include updates to the documentation to reflect your changes if these introduce new or modified functionality.
  • Add or Update Tests: If relevant, add or modify test cases to validate your changes. Double-check that all tests pass before finalizing the PR.
  • Sign the CLA: If this is your first PR to any Ultralytics project, ensure you’ve signed our Contributor License Agreement (CLA) by commenting: "I have read the CLA Document and I sign the CLA".
  • Minimize Changes: Keep your changes scoped to the minimum required for your proposed fix or feature. Bruce Lee once said, "It is not daily increase but daily decrease, hack away the unessential." 🥋

For guidance, please consult our Contributing Guide. If your PR involves fixing a bug or issue, a minimum reproducible example (MRE) is highly recommended to help us better understand and verify the problem. Please provide it in the PR description if not already included.

Thanks again for your contribution and for supporting Ultralytics! 🙌 An Ultralytics engineer will review and assist with your PR shortly 🚀

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

🎉 Exciting news: PR #XX by @pderrenger with contributions from @glenn-jocher has been merged—thank you both for your meticulous work! 🔗📄

"Order is the shape upon which beauty depends." – Bertrand Russell

Your effort to standardize and refine the license headers highlights the beauty of clarity and consistency, both of which are essential in collaborative development. This may seem subtle, but it elevates the professionalism of our project and simplifies the path for future contributors. 🌟

Your thoughtful contributions resonate far beyond the code—thank you for making a lasting impact! 🚀

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