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 Typos to spelling #80

Merged
merged 6 commits into from
Apr 27, 2024
Merged

Add Typos to spelling #80

merged 6 commits into from
Apr 27, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Apr 27, 2024

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Enhancement of GitHub Actions to include automated spelling checks. ✨

πŸ“Š Key Changes

  • Added Spelling Check Step: A new step has been introduced in the GitHub Action workflow specifically for checking typos.
  • Conditional Execution: This spelling check step will only run if the input for spelling is set to true and the GitHub event action is not closed.
  • Automatic Corrections: The action can automatically write changes (correct typos) if any are found.
  • Fault Tolerance: The step is configured to continue even if errors occur, ensuring that workflow execution isn't halted by typo checks.

🎯 Purpose & Impact

  • Enhance Code Quality: By integrating a spelling check, the overall quality and readability of the code and documentation are expected to improve.
  • Automation & Efficiency: Automatically fixing typos saves time for developers and contributors, making the development process smoother and faster.
  • Customizable: By offering it as an opt-in feature (via the spelling input), it provides flexibility to users to decide whether to use this feature based on their project needs.
  • Resilience: Ensuring the workflow continues despite errors in the typo check minimizes disruptions in the CI/CD pipeline.

This update makes maintaining high-quality documentation and codebase easier, ensuring that projects are more accessible and understandable to developers and stakeholders alike. πŸ“πŸ’«

@glenn-jocher glenn-jocher merged commit 36fe0b9 into main Apr 27, 2024
1 check passed
@glenn-jocher glenn-jocher deleted the typos branch April 27, 2024 15:54
glenn-jocher added a commit that referenced this pull request Apr 27, 2024
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