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

Update to ultralytics/action in CI #3

Merged
merged 37 commits into from
Dec 31, 2023
Merged

Update to ultralytics/action in CI #3

merged 37 commits into from
Dec 31, 2023

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Dec 31, 2023

Thank you 🙏 for your contribution to Ultralytics 🚀! Your effort in enhancing our repositories is greatly appreciated. To streamline the process and assist us in integrating your Pull Request (PR) effectively, please follow these steps:

  1. Check for Existing Contributions: Before submitting, kindly explore existing PRs to ensure your contribution is unique and complementary.

  2. Link Related Issues: If your PR addresses an open issue, please link it in your submission. This helps us better understand the context and impact of your contribution.

  3. Elaborate Your Changes: Clearly articulate the purpose of your PR. Whether it's a bug fix or a new feature, a detailed description aids in a smoother integration process.

  4. Ultralytics Contributor License Agreement (CLA): To uphold the quality and integrity of our project, we require all contributors to sign the CLA. Please confirm your agreement by commenting below:

    I have read the CLA Document and I hereby sign the CLA

For more detailed guidance and best practices on contributing, refer to our ✅ Contributing Guide. Your adherence to these guidelines ensures a faster and more effective review process.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Improvements to Automatic Code Formatting Workflow and Code Documentation Enhancements

📊 Key Changes

  • Renamed the GitHub Actions workflow to "Ultralytics Format" for clarity.
  • Simplified the formatting job to use a custom Ultralytics action.
  • The workflow now triggers on pushes to the main branch and pull requests.
  • Expanded the add_numbers function's docstring for better clarity.
  • Added new utility functions with clear docstrings, promoting code readability.

🎯 Purpose & Impact

  • For Users: This PR brings more readable and well-documented code, making it easier to understand and use the functions provided.
  • For Contributors: The streamlined automatic formatting process ensures consistent code style without manual intervention, improving productivity and code quality for future contributions. 🛠️
  • For the Repo: A custom Ultralytics action makes the codebase maintenance simpler and more aligned with internal processes. 🚀

@glenn-jocher glenn-jocher changed the title Actions tests Update to ultralytics/action in CI Dec 31, 2023
@glenn-jocher glenn-jocher merged commit 5655582 into main Dec 31, 2023
1 check passed
@glenn-jocher glenn-jocher deleted the dev branch December 31, 2023 22:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant