For the complete documentation index, see llms.txt. This page is also available as Markdown.

Github PR Review Tool

Our Github Pull Request Review tool allows you to automatically generate an Analysis Report as a comment on your Pull Requests plus use the Ask Village feature for instant feedback.

How use the PR Review Analysis Report Tool

When you create a Pull Request, the @villagelabsco bot will generate an analysis of the diffs and comment back into the PR with the report. The report includes:

  • Code Change Summary

  • Potential Vulnerabilities

  • Code Smells

  • Debug Logs

  • Any Unintended Consequences

  • Risk Score

Depending on the size of the PR, the report can take up to 1 minute to generate. Once the report is generated, it will be posted back into the PR as a comment

Check out the demo below to see how the report posts back to your PR:

How use the Ask Village feature

You can also Ask Village any question directly in your PR for instant feedback and further analysis. To use this feature:

  • Simply type '@villagelabsco question <insert_your_question>' into your PR as a comment and the @villagelabsco bot will post back the answer as a comment.

You must follow the syntax @villagelabsco question <insert_your_question> exactly including the word 'question' to trigger the prompt.

e.g. @villagelabsco question How can I better handle using two Authentication methods?

Check out the demo below to see how the question prompt posts the response back to your PR:

Last updated

Was this helpful?