Reviewpad AI
Reviewpad AI leverages LLM technology and more specifically Open AI to provide a quick, consise and comprehensive understanding of any issue or pull request. You can either summarize the content of a text or of a code change with help of the following commands, marker and built-in.
We only share pull request or issue-related information, such as git patch, with OpenAI. Rest assured, we never transmit information beyond the scope of the pull request or issue. For any concerns, please reach out to us on discord.
/reviewpad summarize
To get the summary of an issue description or of a pull request code change, you just
have to create a new comment with the command /reviewpad summarize. A few seconds later,
Reviewpad AI will answer through a new comment by providing the expected summary.
reviewpad:summary
For situations where embedding a summary directly at the beginning
of the issue or pull request description is preferred over comment-based summaries,
use the marker reviewpad:summary.
Shortly, Reviewpad AI will swap this marker with the expected summary.
Any subsequent modifications to the issue description or the pull request's code will prompt Reviewpad AI to refresh the summary accordingly.
Look out for the eye emoji at the bottom of the description.
This emoji indicates that Reviewpad AI is currently processing the summary.
$summarize()
As part of the reviewpad.yml configuration file you can also automate
the creation of the comment summary with help of the $summarize() built-in.
/reviewpad explain
While doing a code review on a Pull Request, you can get an explanation of any piece of code by creating
an inline comment with the text /reviewpad explain. A few seconds later, Reviewpad AI
will answer through a new inline comment explaining the selected piece of code.
If the inline comment is created on a function name, the overall body of the function is explained. If a multi-line comment is created, the overall block of code is explained.