Code Review - Describe PR¶
This guide explains how CloudAEye generates a PR description.
Overview¶
CloudAEye generates a detailed PR description for code changes when you comment @cloudaeye describe-pr in the PR timeline.
Prerequisites¶
Step 1: Register¶
Sign up with CloudAEye SaaS.
Step 2: Install GitHub App¶
Integrate with GitHub by installing the GitHub app.
Step 3: Connect Github Repositories¶
Connect the repositories where you would like to use CloudAEye for PR descriptions.
Initiate PR Description¶
To initiate a PR description for your connected repository, comment @cloudaeye describe-pr.
PR Description¶
In the PR description, CloudAEye provides a short title for the PR, a detailed description of the code change, and a summary of each file change.
