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

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 formatting across multiple files for consistency and clarity.

📊 Key Changes

  • Standardized formatting of the license header in various YAML and configuration files, adding a dash after "License" for improved consistency.
  • Updated files include GitHub workflow files (.github/workflows/) and essential project configuration files (mkdocs.yml, pyproject.toml, etc.).

🎯 Purpose & Impact

  • Purpose: 🛠 Enhance readability and consistency in license headers, ensuring professionalism and uniformity across the repository.
  • Impact: 📝 No functional changes for users, maintaining code and documentation clarity while aligning with internal standards.

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)
handbook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 15, 2025 4:37pm

@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/handbook 🚀 PR! To ensure a seamless integration of your work, please review the following checklist:

  • Define a Purpose: Clearly explain the purpose of your fix or feature in your PR description, and link to any relevant issues. Ensure your commit messages are clear, concise, and adhere to the project's conventions.
  • Synchronize with Source: Confirm your PR is synchronized with the ultralytics/handbook main branch. If it's behind, update it by clicking the 'Update branch' button or by running git pull and git merge main locally.
  • Ensure CI Checks Pass: Verify all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address the issues.
  • Update Documentation: Update the relevant documentation for any new or modified features.
  • Add Tests: If applicable, include or update tests to cover your changes, and confirm that all tests are passing.
  • Sign the CLA: Please ensure you have signed our Contributor License Agreement if this is your first Ultralytics PR by writing "I have read the CLA Document and I sign the CLA" in a new message.
  • Minimize Changes: Limit your changes to the minimum necessary for your update. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." — Bruce Lee

For more guidance, please refer to our Contributing Guide. Don’t hesitate to leave a comment if you have any questions. Thank you for your contribution to Ultralytics! 🚀

🔍 A note: This is an automated response to help you get started. An Ultralytics engineer will review your PR and provide further feedback if needed. 😊

@pderrenger pderrenger merged commit 2d46430 into main Jan 15, 2025
3 checks passed
@pderrenger pderrenger deleted the refactor-20250115173012 branch January 15, 2025 16:38
@UltralyticsAssistant
Copy link
Member

🎉 Your PR has been merged — incredible work, @pderrenger and @glenn-jocher!

This thoughtful update to standardize license headers reflects the attention to detail that keeps our projects professional and polished. Consistency, as they say, is the glue that holds greatness together.

As Leonardo da Vinci once put it, "Details make perfection, and perfection is not a detail." Your contributions, though subtle, elevate this project closer to perfection. Thank you for your dedication and for making even the smallest changes count! 🚀

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