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

Merged
merged 2 commits 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

Improved formatting in the format.yml workflow file's header comment for better clarity.

📊 Key Changes

  • Updated comment formatting in .github/workflows/format.yml for header text.
    • Adjusted license text layout and spacing for consistency and readability.

🎯 Purpose & Impact

  • 🛠️ Purpose: Enhance the readability and professionalism of the workflow file comments.
  • 🌟 Impact: Provides clearer documentation within the file, promoting better understanding for developers reviewing or utilizing the workflow.

@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/xview-docker 🚀 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/xview-docker 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. Thank you for contributing to Ultralytics! 🚀

📚 For this PR, I noticed the title mentions standardization of license headers in TOML/YAML files. Please ensure:

  1. All files affected by the proposed changes have been updated consistently with the new format.
  2. If possible, include an example (or mention) of the modified format directly in the description for better clarity.
  3. Cross-check that these updates align with our existing licensing standards. More information on our license can be found at Ultralytics licensing.

🚀 We appreciate your effort to maintain project quality! This response is automated, but an Ultralytics engineer will review your pull request in more detail shortly.

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

🚀 Your PR has been merged, @pderrenger, with invaluable contributions from @glenn-jocher—thank you both for your attention to detail! 🌟

By enhancing the clarity and professionalism of the format.yml workflow, you've made a lasting impact on the developer experience within this project. As Leonardo da Vinci once said, "Simplicity is the ultimate sophistication." Your efforts to refine even the smallest details embody this principle and elevate the quality of our work. 🙌

Keep shining and contributing brilliance—together, we’re making coding—and the world—a bit better, one line at a time. 🌎💡

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