help improved

[mrT23]

Type

enhancement

---

Description

• Introduced GithubProvider import in pr_description.py and pr_help_message.py to enhance GitHub integration.
• Enhanced PR description logic in pr_description.py to support a new enable_help_comment setting, allowing for the inclusion of a help guide comment in PR descriptions specifically for GitHub.
• Refactored pr_help_message.py to dynamically generate a help message with a list of tools, their descriptions, and commands or checkboxes, depending on the git provider.
• Updated configuration.toml to disable enable_help_text and enable enable_help_comment, shifting the help guide from text to comment format.

---

Changes walkthrough

	Relevant files
Enhancement	pr_description.py Enhance PR Description with Conditional Help Guide Support pr_agent/tools/pr_description.py Import GithubProvider from git_providers. Add support for enable_help_comment setting to include a help guide comment in PR descriptions for GitHub. Include a conditional block to append a specific help guide format based on the git provider. +7/-1      pr_help_message.py Refactor and Enhance PR Help Message for GitHub                    pr_agent/tools/pr_help_message.py Import GithubProvider from git_providers. Refactor the help message generation to support a dynamic list of tools with descriptions and commands. Introduce a table format for the help message that varies based on the git provider (GitHub-specific enhancements). Add conditional logic for GitHub to include checkboxes and commands in the help message. +83/-16
Configuration changes	configuration.toml Update Configuration to Use Help Comments Instead of Help Text pr_agent/settings/configuration.toml Disable enable_help_text setting. Enable enable_help_comment setting to activate help comments in PR descriptions. +2/-1

---

✨ Usage guide:

---

Overview:
The describe tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

When commenting, to edit configurations related to the describe tool (pr_description section), use the following template:

/describe --pr_description.some_config1=... --pr_description.some_config2=...

With a configuration file, use the following template:

[pr_description]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the describe tool is: pr_commands = ["/describe --pr_description.add_original_user_description=true" "--pr_description.keep_original_user_title=true", ...] meaning the describe tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description. Markers are an alternative way to control the generated description, to give maximal control to the user. If you set: pr_commands = ["/describe --pr_description.use_description_markers=true", ...] the tool will replace every marker of the form pr_agent:marker_name in the PR description with the relevant content, where marker_name is one of the following: type: the PR type. summary: the PR summary. walkthrough: the PR walkthrough. Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.

Custom labels The default labels of the describe tool are quite generic: [Bug fix, Tests, Enhancement, Documentation, Other]. If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases. Examples for custom labels: Main topic:performance - pr_agent:The main topic of this PR is performance New endpoint - pr_agent:A new endpoint was added in this PR SQL query - pr_agent:A new SQL query was added in this PR Dockerfile changes - pr_agent:The PR contains changes in the Dockerfile ... The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases. Note that Labels are not mutually exclusive, so you can add multiple label categories. Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.

Inline File Walkthrough 💎 For enhanced user experience, the describe tool can add file summaries directly to the "Files changed" tab in the PR page. This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs). To enable inline file summary, set pr_description.inline_file_summary in the configuration file, possible values are: 'table': File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab. true: A collapsable file comment with changes title and a changes summary for each file in the PR. false (default): File changes walkthrough will be added only to the "Conversation" tab.

Utilizing extra instructions The describe tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description. Examples for extra instructions: [pr_description] extra_instructions=""" - The PR title should be in the format: '<PR type>: <title>' - The title should be short and concise (up to 10 words) - ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the describe usage page for a comprehensive guide on using this tool.

[codiumai-pr-agent-pro]

PR Description updated to latest commit (34e89e4)

• Copy walkthrough table to "Files Changed" Tab

[codiumai-pr-agent-pro]

PR Review

PR feedback
⏱️ Estimated effort to review [1-5]	3, because the changes involve both logic enhancements and configuration adjustments across multiple files. The logic changes are not overly complex but require a good understanding of the existing system and the implications of the new settings.
🧪 Relevant tests	No
🔍 Possible issues	The conditional logic for enable_help_comment in pr_description.py assumes only GitHub as a provider for now. If more providers with similar features are added in the future, this might require additional refactoring. In pr_help_message.py, the handling of commands and checkbox lists for GitHub is hardcoded. This could become difficult to maintain if the list of tools or their descriptions change frequently.
🔒 Security concerns	No

---

✨ Usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: [pr_reviewer] # /review # extra_instructions=""" In the 'possible issues' section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation When you first install PR-Agent app, the default mode for the review tool is: pr_commands = ["/review", ...] meaning the review tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations

Auto-labels The review tool can auto-generate two specific types of labels for a PR: a possible security issue label, that detects possible security issues (enable_review_labels_security flag) a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)

Extra sub-tools The review tool provides a collection of possible feedbacks about a PR. It is recommended to review the possible options, and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: require_score_review, require_soc2_ticket, and more.

Auto-approve PRs By invoking: /review auto_approve The tool will automatically approve the PR, and add a comment with the approval. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: [pr_reviewer] enable_auto_approval = true (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository) You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag: [pr_reviewer] maximal_review_effort = 5

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

[codiumai-pr-agent-pro]

PR Code Suggestions

	Suggestions
performance	Improve string concatenation efficiency in pr_body construction. Consider using a more efficient string concatenation method for building pr_body. Using the += operator in a loop for string concatenation can lead to quadratic runtime complexity in the worst case. Instead, append strings to a list and use join() at the end. pr_agent/tools/pr_description.py [111] -pr_body +="\n\n___\n\n✨ **PR-Agent usage guide**:\n\n- [ ] Mark this checkbox :gem:, or comment `/help` on the PR, to get a list of PR-Agent tools and their descriptions. <!-- /help -->" +pr_body_parts = [ + "\n\n___\n\n✨ **PR-Agent usage guide**:\n\n- [ ] Mark this checkbox :gem:, or comment `/help` on the PR, to get a list of PR-Agent tools and their descriptions. <!-- /help -->" +] +pr_body = "".join(pr_body_parts)
maintainability	Use a structured data approach for tool information management.               Instead of manually appending strings to tool_names, descriptions, commands, and checkbox_list, consider using a data structure like a list of dictionaries or a class to encapsulate tool information. This approach can simplify the code and make it easier to maintain and extend. pr_agent/tools/pr_help_message.py [18-67] -tool_names.append(f"[DESCRIBE]({base_path}/DESCRIBE.md)") -descriptions.append("Generates PR description - title, type, summary, code walkthrough and labels") -commands.append("`/describe`") -checkbox_list.append(" - [ ] Send <!-- /describe -->") +tools = [ + {"name": "DESCRIBE", "description": "Generates PR description - title, type, summary, code walkthrough and labels", "command": "`/describe`", "checkbox": " - [ ] Send <!-- /describe -->"}, + # Add other tools here +] Clarify the purpose of enable_help_comment in the configuration. The configuration option enable_help_comment is set to true while enable_help_text is removed, which might cause confusion. If both settings are meant to control similar features but in different contexts, consider renaming them for clarity or adding comments in the configuration file to explain their purposes. pr_agent/settings/configuration.toml [62] +# enable_help_comment controls whether to add a help comment in PRs +# Consider renaming or adding explanations for clarity enable_help_comment=true
enhancement	Simplify the loop for building pr_comment with tool information. The loop that builds pr_comment with tool information can be simplified by using a single loop instead of separate loops for GitHub and other providers. This can be achieved by preparing the table rows in advance and then concatenating them into the final string. pr_agent/tools/pr_help_message.py [76-77] -for i in range(len(tool_names)): - pr_comment += f"\n<tr><td align='center'>\n\n<strong>{tool_names[i]}</strong></td>\n<td>{descriptions[i]}</td>\n<td>\n\n{checkbox_list[i]}\n</td></tr>" +table_rows = [f"\n<tr><td align='center'>\n\n<strong>{tool['name']}</strong></td>\n<td>{tool['description']}</td>\n<td>\n\n{tool['checkbox']}\n</td></tr>" for tool in tools] +pr_comment += "".join(table_rows)
best practice	Abstract git provider checks into a method for better extensibility.          The conditional checks for GithubProvider could be abstracted into a method within the git_provider class hierarchy. This would allow for a more object-oriented approach, making it easier to add support for new git providers in the future without modifying the conditional logic in multiple places. pr_agent/tools/pr_description.py [110] -if isinstance(self.git_provider, GithubProvider): +if self.git_provider.supports_feature("help_comment"):

---

✨ Usage guide:

---

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the improve tool is: pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

Utilizing extra instructions Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: [pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

A note on code suggestions quality While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool With large PRs, best quality will be obtained by using 'improve --extended' mode.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the improve usage page for a more comprehensive guide on using this tool.