Supercharge Your Pull Requests with the /describe Command

Streamline your pull request (PR) process and save valuable time with our feature-packed tool. Let our PR Agent do the heavy lifting by automatically crafting PR descriptions, assigning labels, highlighting code modifications, and distinguishing between bugs and new features effortlessly.

What is /describe & why is it a game changer for pull requests?

The describe command is like having a personal PR copywriter within Codium AI's PR agent. It's a handy tool that automatically generates a comprehensive and informative description for your pull request, saving you time and effort.

How does the magic behind /describe work?

The /describe tool scans the PR code changes and automatically generates a PR description, including title, type, summary, code walkthrough, and labels. It can be invoked manually by commenting on any PR.

Here's how it revolutionizes your workflow:

  • Clear and Purposeful Titles: Craft clear and concise titles that reflect the essence of your PR, enhancing communication within your team.
  • Automated Description Generation: Instantly generate detailed descriptions based on your code changes, saving you from manual write-ups.
  • Impact Summary: Gain a quick overview of your changes and their potential impact, helping your team understand the scope at a glance.
  • Guided Code Walkthrough: Simplify code comprehension with guided walkthroughs, aiding in decision-making and fostering collaboration.
  • Efficient Labeling: Easily identify the nature of your changes, whether it's a bug fix, feature addition, or refactoring, for better categorization.

Simplify your PR descriptions, expedite approvals, and boost collaboration among your team with the game-changing /describe command from Codium AI’s PR agent.

Get started with /describe and unfold the magic

Start by typing “/describe” (without the quotes) in the comment section of your pull request:

Describe

Now give the PR agent a few seconds to scan the code changes in the pull request and craft a beautiful description with a proper title, labels, summary, and code walkthrough like this:

Describe

Here's what it covers:

  • Title: Crafts a concise, clear title that accurately reflects the PR's purpose.
  • Type: Identifies the type of change, like bug fix, feature addition, or refactoring.
  • Summary: Provides a high-level overview of the changes made and their impact.
  • Code Walkthrough: Walks through the key changes in the code, highlighting important points and decisions.
  • Labels: Suggest relevant labels for the PR based on its content, helping with categorization and organization.

Title:

A concise, descriptive phrase that summarizes the pull request's purpose or the problem it addresses. It acts as a snapshot overview, enabling quick understanding of the PR's intent.

Type:

Identifies the category of change being introduced in the pull request. Common types include: bug fix, feature addition, refactoring, documentation update, or other relevant classifications. It clarifies the nature of the alterations made, providing context for reviewers.

Summary:

A brief high-level overview of the modifications made in the pull request. It outlines the key changes to the code base, highlighting their impact or significance. Helps reviewers grasp the scope of the alterations and their implications.

Code Walkthrough:

A guided tour through the significant changes made in the code. It points out key modifications, explains decision-making processes, and highlights crucial aspects. Provides a comprehensive understanding of the code alterations and the rationale behind them..

Labels:

Relevant keywords or tags are applied to the PR to aid in organization and categorization. It facilitates filtering, prioritizing, and managing code changes efficiently. Common examples include: bug, feature, priority, area of code, or release milestone.

Automating the /describe command

The /describe tool can also be triggered automatically every time a new PR is opened, an existing PR is reopened, a PR is moved from Draft to Open, and when a review is requested. It can be automated using GitHub App or GitHub Actions.

Frequently Asked Questions

  • I just want to auto-generate the code walkthrough but not the description; can I do that?

    Certainly. The PR-Agent offers comprehensive configuration settings, allowing precise control over content generation using the /describe command. Should you prefer not to auto-generate a description, the pr_description section within the configuration file provides the necessary flexibility to tailor the behavior of the /describe command.

  • I want to use the /describe command, but I have my format to show the description; can I embed it along with my content?

    This is certainly possible. The "markers" functionality allows users to insert placeholders or tags within the PR description. These markers serve as triggers for the PR agent, facilitating the dynamic replacement of user-provided content with auto-generated insights, such as summaries or code walkthroughs. This functionality simplifies the fusion of user-provided information with AI-generated data in a structured and standardized format.

Have More Questions?

JOIN OUR DISCORD

CodiumAI