Skip to content

Update links.yml to remove --require-https #45

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

Merged
merged 1 commit into from
Jan 13, 2024

Conversation

glenn-jocher
Copy link
Member

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

Update to link-checking workflow in Ultralytics documentation repository.

📊 Key Changes

  • Removed the --require-https flag from the lychee link checker configuration.

🎯 Purpose & Impact

  • 🌐 The purpose is to improve the link validation process by not strictly requiring HTTPS for all checked URLs.
  • 🔗 This may reduce false-positive error rates for link checking, especially for URLs that may not enforce HTTPS but are still reachable and valid.
  • 👥 For users and developers, this change aims to reduce confusion and maintenance work related to fixing or investigating broken link errors that aren't actually broken.

@glenn-jocher glenn-jocher merged commit 989f82b into main Jan 13, 2024
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch January 13, 2024 21:42
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