AI Pull Summaries

Instantaneously generate high-level summaries of pull requests that outline the changes being introduced. AI summaries can be automatically inserted into your pull request description, saving you valuable time when creating new pull requests.

How AI Summaries Are Generated

Our pull request summaries are generated using all available context on the pull request at the time of generation. This often involves inspecting the entire diff, the commit history, any existing review comments, as well as the existing description on the pull request if available. This comprehensive context is used to create an informative and helpful summary of the changes being introduced by the pull request, which is useful for participants of the pull request.

How to Use AI Summaries

It's up to you to determine how you leverage our AI pull request summaries. You can have them automatically inserted into the description of every new pull request that is created or you can manually generate them for any pull request on demand. They're a powerful tool for understanding how a pull request operates, whether that's for your own personal understanding or published for the consumption of others.

Automatic Summaries in Pull Request Descriptions

To have an AI-generated summary automatically included in your pull request description, add the tag <!-- CodePeerSummary --> anywhere in the description field. Any time you create a new pull request, CodePeer detects this tag and asynchronously generates a summary for you. In just a few seconds, the summary replaces the tag with a detailed overview of the changes. This works on any repository connected to CodePeer.

Pull Request Templates

CodePeer's integrates seamlessly with pull request templates, if you happen to use them. Simply add the <!-- CodePeerSummary --> tag to your template whereever you'd like the summary to be inserted, and we'll populate the description with an AI generated summary upon pull request creation.

On Demand Pull Request Summaries

Inside of the CodePeer application, at the top of every pull request, you'll see a "AI Summary" button. Clicking this button will launch a modal that automatically generates a detailed summary of the changes introduced by the pull request.

After generating a summary, you have the ability to update the pull request description using the generated summary by clicking "Apply to Description". If you choose to apply the summary to the description, we'll do the following:

1. Search for the <!-- CodePeerSummary --> tag and replace it with the generated summary.
2. If the tag is not found, but a previously generated summary is, we'll replace the existing summary with the new one.
3. If the tag is not found and no previously generated summary exists, we'll replace the entire description with the generated summary.

You're under no obligation to apply the pull request summary to the description of the pull request. The feature is designed so any pull request participant can generate a summary at any time, even if it's just for their own personal understanding of the changes being introduced. Although, if you're just curious to learn more about the pull request, we highly recommend using our AI Chat Bot.