Skip to main content
In addition to reviewing code, Mesa can also generate descriptions for your pull requests.

​
Description Configuration

​
Placement

You can decide where Mesa will place the description in the pull request. Mesa currently offers two options:
  • Body (Default): The description will be placed in the body of the pull request. When placed in the body of the pull request, Mesa will update the existing description in the body of the pull request, aiming to avoid overwriting any existing content. We typically recommend placing the description in the body of the pull request, as this is more visible and editable.
  • Comment: The description will be placed as a comment in the pull request. When placed as a comment, Mesa will post a new comment with a new description each time it is generated. This is a good option for teams that like to enforce a more strict separation between bot-generated and human-generated content.

​
Triggering

There are a few ways to trigger description generation:
  1. Automatically when a pull request is opened or reopened
  2. Automatically when new commits are pushed to the pull request
  3. When a user mentions @mesa-dot-dev describe in a comment
  4. When a user types /describe in a comment
In addition, you can configure Mesa to generate descriptions only for PRs that meet certain criteria, such as:
  • Having a certain number of lines of code changed
  • Having a specific set of labels
  • Being authored by a specific user

​
Template

You can configure a Markdown template for your descriptions. If your team already has a Github repository template, you can configure Mesa to respect the template if it exists.

​
Diagrams

You can configure Mesa to generate Mermaid diagrams in your descriptions. This is a great way to visualize the changes in your pull request.