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 action.yml spelling skip list #49

Merged
merged 3 commits into from
Jan 9, 2024
Merged

Update action.yml spelling skip list #49

merged 3 commits into from
Jan 9, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jan 9, 2024

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

Enhanced spell-check exclusions for various file types in GitHub actions.

πŸ“Š Key Changes

  • Expanded the spell-check ignore list to include additional file extensions like .npy, .data*, *.pnnx, __pycache__*, *.ico, *.jpg, *.png, *.mp4, and *.mov.
  • Excluded additional directories such as /runs and /.git.
  • Refined documentation exclusions by specifying .md files in certain docs directories.

🎯 Purpose & Impact

  • Minimize False Positives: By ignoring more irrelevant file types, the spell-check process is streamlined, reducing noise from false positives.
  • Improve CI Efficiency: This will speed up the continuous integration process, making it quicker and more efficient as it avoids checking file types and directories that don't contain relevant content for spelling checks.
  • Reduce Developer Distraction: Developers can focus on actual code and documentation typos rather than sorting through irrelevant spell-check results.

πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’» Users can expect cleaner spell-check results, leading to a more efficient development workflow.

@glenn-jocher glenn-jocher merged commit 33f6177 into main Jan 9, 2024
1 check passed
@glenn-jocher glenn-jocher deleted the spelling branch January 9, 2024 16:06
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

1 participant