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

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 GitHub workflow headers to enhance clarity and formatting.

📊 Key Changes

  • Adjusted header formatting in .github/workflows/format.yml and .github/workflows/tag.yml files.
  • Improved consistency by adding a hyphen and reordering text in license comments.

🎯 Purpose & Impact

  • 📄 Improved readability: The updated headers make the license and workflow descriptions clearer.
  • 🔍 Consistency: Ensures standardized formatting across workflow files for a polished repository.
  • No functional impact: These are purely cosmetic changes, with no effect on workflow 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 an ultralytics/assets 🚀 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/assets 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 bug fix or feature addition. "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. An Ultralytics engineer will review this shortly. Thanks again for contributing to Ultralytics! 🎉

@pderrenger pderrenger merged commit a2a2b76 into main Jan 15, 2025
1 check passed
@pderrenger pderrenger deleted the refactor-20250115173012 branch January 15, 2025 16:36
@UltralyticsAssistant
Copy link
Member

🎉 Exciting news—this PR is officially merged! A huge thank you to @pderrenger for your thoughtful updates and to @glenn-jocher for your collaborative spirit. 🛠️ Your meticulous efforts to polish and clarify our workflows are a reminder that even small, consistent improvements have a profound impact on the bigger picture.

As Leonardo da Vinci once said, "Details make perfection, and perfection is not a detail." Your work helps bring clarity and consistency to our project, creating a brighter, more refined path for all who contribute. 💫 Keep shining and coding! 🚀

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