Skip to content

Comments

Add markdown link checker to pre-commit#29

Open
Aashish-Jha-11 wants to merge 2 commits intoSalamLang:mainfrom
Aashish-Jha-11:add-markdown-link-check
Open

Add markdown link checker to pre-commit#29
Aashish-Jha-11 wants to merge 2 commits intoSalamLang:mainfrom
Aashish-Jha-11:add-markdown-link-check

Conversation

@Aashish-Jha-11
Copy link
Contributor

Adds markdown-link-check hook to validate all links in markdown files automatically.

Closes #19

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @Aashish-Jha-11, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces an automated link validation mechanism for markdown files by integrating the markdown-link-check tool into the pre-commit configuration. This enhancement aims to proactively identify and prevent broken links from being committed, thereby maintaining the quality and accuracy of the project's documentation.

Highlights

  • New Pre-Commit Hook: A new pre-commit hook, markdown-link-check, has been added to automatically validate all links within markdown files.
  • Automated Link Validation: This hook ensures that all external and internal links in markdown documentation are valid, preventing broken references and improving documentation reliability.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds a markdown-link-check pre-commit hook to validate links in Markdown files. The implementation is correct, but I've suggested adding an explicit configuration file to make the hook more robust and prevent potential false positives from failing builds in the future. This will improve the long-term maintainability of this check.

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.

Add markdown-link-check to pre-commit

2 participants