Skip to content

/describe

Description

The /describe command in Codiumate is designed to streamline the process of preparing pull requests (PRs) and understanding changes within your workspace. By invoking this command with a focus on selected changes (local, staged, or committed), Codiumate generates a structured description of the changeset. This includes a title, type of changes (e.g., bug fix, feature addition, performance improvement), and a detailed description. This functionality is particularly useful for developers looking to summarize their work before opening a PR, ensuring that colleagues and contributors can quickly grasp the intent and scope of the changes.

How to Use

To utilize the /describe command effectively, follow these steps:

  1. Select Your Changeset: Identify the scope by selecting file, local, staged, or committed changes.

  2. Select Target Branch (for committed changes): If your focus is on reviewing committed changes, you must select the target branch to which your current working branch will be compared. This step is crucial for understanding the context and impact of the changes within the broader project scope. For local or staged changes, proceed directly to initiating the command as these do not require a target branch selection.

  3. Initiate the Command: Type /describe in the chat interface. Codiumate then processes your selected changes and compiles a structured description, including a suggested title, the type of changes made, and a comprehensive description of the changeset.

  4. Review and Use the Description: Review the generated description for accuracy and completeness. You can then use this structured summary directly in your Git PR, facilitating clear communication and efficient collaboration with your team.

Available in

Threads

This command supports threading. Read more about Threads.

Features + Bug fixed PR Description

Command:

/describe

Response:

  • Title: "Feature Addition and Bug Fixes in User Authentication Flow"
  • Type: Feature, Bug Fix
  • Description: Introduces a new two-factor authentication feature to enhance security during user login. Additionally, it addresses previously reported bugs in the password reset flow, including error handling and email verification. These changes improve the overall reliability and security of the authentication process.

New feature PR Description

Command:

/describe

Response:

  • Title: "Implement Feature X"
  • Type: Feature
  • Description: This pull request introduces a new middleware for user authentication. The middleware validates user credentials against the authentication service and grants access if authentication is successful. It enhances the security of our application by adding a layer of protection to routes that require user authentication.

PR Description with additional instructions

Command:

/describe and use these sub-headings in the description i.e. Nature of change, Change Score and Test suite added

Response:

  • Title: "Implement User Authentication Middleware"
  • Type: Feature
  • Description: This pull request introduces a new middleware for user authentication. The middleware validates user credentials against the authentication service and grants access if authentication is successful.
    • Nature of change: It enhances the security of our application by adding an additional layer of protection to routes that require user authentication.
    • Change Score: The change score is high.
    • Test suite added: No test suite has been added with this change.
Footer