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

Add Ultralytics actions workflow in format.yml #4

Closed

Conversation

UltralyticsAssistant
Copy link
Member

@UltralyticsAssistant UltralyticsAssistant commented Jan 1, 2024

This pull request adds a workflow to automatically format code and documentation.

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Introducing automatic code formatting for Ultralytics repositories 🖌️✨

📊 Key Changes

  • Added a GitHub Actions workflow file named format.yml
  • Automated code and documentation formatting on pushes and pull requests to main and master branches
  • Updated importcsvNeutronFile.m to clear temporary variables with a small tweak in variable naming

🎯 Purpose & Impact

  • Consistency: Ensures a consistent code style across the project, which simplifies reading and maintaining code. 📏
  • Efficiency: Saves time for contributors by automating formatting, allowing them to focus on code logic and features. ⏱️
  • Quality Control: Reduces the chances of human error and improves overall code quality. 🛠️
  • Small adjustment in importcsvNeutronFile.m could be a bug fix or typo correction. (Note that it might be a mistake since 'ans' seems to be a valid Matlab temporary variable whereas 'and' is a logical operator.)

The impact is an increase in productivity for developers and a more streamlined contribution process for potential future updates or changes to the Ultralytics codebase. Users should experience the benefits indirectly through improved software robustness and consistency.

@glenn-jocher glenn-jocher deleted the add-format-workflow-20240101025557 branch January 7, 2024 23:33
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.

None yet

2 participants