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

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

Updated GitHub Actions workflow formatting for consistency and clarity 🚀.

📊 Key Changes

  • Adjusted comment formatting in the format.yml GitHub Actions file for better readability and structure.

🎯 Purpose & Impact

  • Ensures comments adhere to a clean and uniform style, improving maintainability and clarity for contributors. 🛠️
  • No functional changes; strictly a cosmetic update to enhance codebase quality 🌟.

@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 a PR to the ultralytics/JSON2YOLO 🚀 repository! To ensure a smooth review and integration process, please ensure that the following checklist is completed:

  • Define a Purpose: Clearly outline the purpose of your PR in the description (e.g., issues it resolves, features it introduces, or bugs it fixes). If your work relates to an existing issue, please reference it. Make sure your commit messages are concise and adhere to the repository's conventions.
  • Keep Your Branch Updated: Confirm that your branch is in sync with the main branch. If it is not, resolve the discrepancies by clicking the 'Update branch' button or by running git pull and git merge main locally.
  • Pass CI Checks: Ensure that all Continuous Integration (CI) checks pass successfully. If there are any failures, please address them accordingly.
  • Document Your Changes: For any introduced or modified functionality, update the relevant documentation.
  • Add or Update Tests: Include tests when applicable, and verify that all tests pass.
  • Sign the CLA: If this is your first contribution to Ultralytics, confirm that you have signed the Contributor License Agreement by commenting, "I have read the CLA Document and I sign the CLA."
  • Stay Focused: Ensure the changes you introduce are minimal and directly relevant to the stated purpose of your PR. "Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away." — Antoine de Saint-Exupéry

Key Notes 📝

  • 🚀 Changes including updates to license headers and standardization are important for the maintainability of the project. Consistency improves the readability and professionality of the repository.
  • 📋 If this PR addresses a bug or issue, please provide a minimum reproducible example (MRE) for verification and testing, if relevant.

For additional guidance, check out the Contributing Guide. Feel free to leave a comment if you have questions or need assistance with anything specific! 😊 An Ultralytics engineer will review and assist you directly soon. Thanks again for contributing to Ultralytics! 🚀

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

🎉 PR Merged! 🎉

Thank you, @pderrenger, for championing clarity with this workflow update and @glenn-jocher for your valuable contributions! Your attention to the small details that elevate the whole truly resonates with a timeless insight from Leonardo da Vinci: "Simplicity is the ultimate sophistication." 🚀

While this was a cosmetic update, it’s the thoughtful refinements like these that make a project more accessible and inspiring for all future collaborators. Your work doesn’t just update code—it sets a standard. 💡🌟

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