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

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 formatting and comments across configuration files to improve consistency and readability.

📊 Key Changes

  • Adjusted the formatting of license comments in .github/workflows/format.yml and pyproject.toml for a cleaner and more uniform style.
    • Example: Changed AGPL-3.0 License https://ultralytics.com/license to AGPL-3.0 License - https://ultralytics.com/license.

🎯 Purpose & Impact

  • 🧹 Improved Consistency: Ensures that license and style guidelines across files are uniform.
  • 👓 Better Readability: Cleaner comments make it easier for contributors to understand and navigate the files.
  • 🚫 No functional changes, so no direct impact on users or software behavior.

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

  • Define a Purpose: Provide a clear explanation of the purpose of your updates in the PR description and link any related issues. For clarity, ensure your commit messages are concise and descriptive.
  • Synchronize with Source: Confirm your PR is up-to-date with the main branch of the ultralytics/notebooks repository. If your branch is outdated, update it by clicking 'Update branch' on the PR page or running git pull followed by git merge main locally.
  • Ensure CI Checks Pass: Check that all Ultralytics Continuous Integration (CI) checks have been successfully completed. Address any failing checks before requesting reviews.
  • Update Documentation: Make sure that relevant updates to the documentation have been made to reflect your changes, if applicable.
  • Add Tests: Provide or update relevant tests if your changes affect code functionality. Confirm that all tests pass successfully.
  • Sign the CLA: If this is your first contribution to Ultralytics, please sign the Contributor License Agreement (CLA) by commenting "I have read the CLA Document and I sign the CLA" on the PR.
  • Minimize Changes: Ensure your PR includes only the changes needed for its purpose. Clean, concise contributions help maintain repository quality. "Simplicity is the ultimate sophistication." — Leonardo da Vinci

If you would like more information, please refer to our Contributing Guide. If there are any issues, don't hesitate to ask for assistance. Thank you for your contribution to making Ultralytics better! 🌟

🚨 Please note that this is an automated response, but rest assured that an Ultralytics engineer will review and assist with your PR promptly. Let us know if additional help is needed.

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

✨ PR Merged! ✨

Huge thanks to @pderrenger for this thoughtful contribution and to @glenn-jocher for the collaborative effort!🎉 Your work on improving the consistency and readability of configuration files is a fantastic example of the power of attention to detail.

As Leonardo da Vinci once said, “Simplicity is the ultimate sophistication.” By refining even the smallest elements, you've helped elevate the clarity and precision of this project, making it more accessible for everyone. 💡

Your work may seem subtle, but it builds the foundation for long-term excellence. Thank you for making a difference! 🌟🚀

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