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 links.yml #526

Merged
merged 1 commit into from
Jan 8, 2024
Merged

Update links.yml #526

merged 1 commit into from
Jan 8, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jan 8, 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

Enhancing link validation workflow for project documentation.

📊 Key Changes

  • Syntax format improved in the link-checking commands for better readability and maintenance.
  • Now uses a backslash (\) at the end of each line to clearly separate options and targets within the lychee validation command.
  • Expanded the scope of link validation to include .html, .yml, .yaml, .py, and .ipynb files in the repository.

🎯 Purpose & Impact

  • The improved format makes the workflow file easier to read and edit, which could help future maintainers. 🤓
  • By expanding the file types checked, the likelihood of broken or stale links in the project's documentation decreases, ensuring a smoother experience for users accessing the resources. 📚
  • Regularly checking for link validity across more file types helps maintain high-quality documentation, potentially reducing user frustration and improving trust in the project. 🛠️

@glenn-jocher glenn-jocher merged commit 4d01513 into main Jan 8, 2024
4 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch January 8, 2024 17:56
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