Update TOOLS_GUIDE.md

Merge pull request #630 from Codium-ai/tr/language
2025-07-06 05:40:38 +08:00 · 2024-01-30 08:22:29 +02:00 · 2024-01-30 08:21:43 +02:00 · 2024-01-29 12:11:23 -08:00 · 2024-01-29 22:00:11 +02:00 · 2024-01-29 21:52:54 +02:00
35 changed files with 1324 additions and 437 deletions
--- a/.github/workflows/pr-agent-review.yaml
+++ b/.github/workflows/pr-agent-review.yaml
@ -27,7 +27,9 @@ jobs:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          PINECONE.API_KEY: ${{ secrets.PINECONE_API_KEY }}
          PINECONE.ENVIRONMENT: ${{ secrets.PINECONE_ENVIRONMENT }}
-          GITHUB_ACTION.AUTO_REVIEW: true
-          GITHUB_ACTION.AUTO_IMPROVE: true
+          GITHUB_ACTION_CONFIG.AUTO_DESCRIBE: true
+          GITHUB_ACTION_CONFIG.AUTO_REVIEW: true
+          GITHUB_ACTION_CONFIG.AUTO_IMPROVE: true
+


--- a/.gitignore
+++ b/.gitignore
@ -6,3 +6,4 @@ dist/
 *.egg-info/
 build/
 review.md
+.DS_Store
--- a/INSTALL.md
+++ b/INSTALL.md
@ -3,8 +3,8 @@

 To get started with PR-Agent quickly, you first need to acquire two tokens:

-1. An OpenAI key from [here](https://platform.openai.com/), with access to GPT-4.
-2. A GitHub\GitLab\BitBucket personal access token (classic) with the repo scope.
+1. An OpenAI key from [here](https://platform.openai.com/api-keys), with access to GPT-4.
+2. A GitHub\GitLab\BitBucket personal access token (classic), with the repo scope. [GitHub from [here](https://github.com/settings/tokens)]

 There are several ways to use PR-Agent:

@ -79,12 +79,14 @@ codiumai/pr-agent@v0.9
 git clone https://github.com/Codium-ai/pr-agent.git
 ```

-2. Install the requirements in your favorite virtual environment:
+2. Navigate to the `/pr-agent` folder and install the requirements in your favorite virtual environment:

 ```
-pip install -r requirements.txt
+pip install -e .
 ```

+*Note: If you get an error related to Rust in the dependency installation then make sure Rust is installed and in your `PATH`, instructions: https://rustup.rs*
+
 3. Copy the secrets template file and fill in your OpenAI key and your GitHub user token:

 ```
@ -93,10 +95,9 @@ chmod 600 pr_agent/settings/.secrets.toml
 # Edit .secrets.toml file
 ```

-4. Add the pr_agent folder to your PYTHONPATH, then run the cli.py script:
+4. Run the cli.py script:

 ```
-export PYTHONPATH=[$PYTHONPATH:]<PATH to pr_agent folder>
 python3 -m pr_agent.cli --pr_url <pr_url> review
 python3 -m pr_agent.cli --pr_url <pr_url> ask <your question>
 python3 -m pr_agent.cli --pr_url <pr_url> describe
@ -107,6 +108,11 @@ python3 -m pr_agent.cli --issue_url <issue_url> similar_issue
 ...
 ```

+[Optional] Add the pr_agent folder to your PYTHONPATH
+```
+export PYTHONPATH=$PYTHONPATH:<PATH to pr_agent folder>
+```
+
 ---

 ### Run as a GitHub Action
--- a/README.md
+++ b/README.md
@ -19,10 +19,82 @@ Making pull requests less painful with an AI agent
    <img alt="GitHub" src="https://img.shields.io/github/last-commit/Codium-ai/pr-agent/main?style=for-the-badge" height="20">
    </a>
 </div>
+
+## Table of Contents
+- [News and Updates](#news-and-updates)
+- [Overview](#overview)
+- [Example results](#example-results)
+- [Try it now](#try-it-now)
+- [Installation](#installation)
+- [PR-Agent Pro 💎](#pr-agent-pro-)
+- [How it works](#how-it-works)
+- [Why use PR-Agent?](#why-use-pr-agent)
+  
+## News and Updates
+### Jan 28, 2024
+- 💎 Test - A new tool, [`/test component_name`](https://github.com/Codium-ai/pr-agent/blob/main/docs/TEST.md), was added to PR-Agent Pro. The tool will generate tests for a selected component, based on the PR code changes.
+- 💎 Analyze - The [`/analyze`](https://github.com/Codium-ai/pr-agent/blob/main/docs/Analyze.md) tool was updated and simplified. It now presents a summary of the code components that were changed in the PR.
+### Jan 21, 2024
+- 💎 Custom suggestions - A new tool, `/custom_suggestions`, was added to PR-Agent Pro. The tool will propose only suggestions that follow specific guidelines defined by the user. 
+See [here](https://github.com/Codium-ai/pr-agent/blob/main/docs/CUSTOM_SUGGESTIONS.md) for more details.
+
+### Jan 17, 2024
+- 💎 Inline file summary - The `describe` tool has a new option `--pr_description.inline_file_summary`, which allows to add a summary of each file changes to the Diffview page. See [here](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#inline-file-summary-)
+- The `improve` tool can now present suggestions in a nice collapsible format, which significantly reduces the PR footprint. See [here](https://github.com/Codium-ai/pr-agent/blob/main/docs/IMPROVE.md#summarized-vs-commitable-code-suggestions) for more details. 
+- To accompany the improved interface of the  `improve` tool, we change the [default automation settings](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L116) of our GithupApp to:
+```
+pr_commands = [
+    "/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
+    "/review --pr_reviewer.num_code_suggestions=0",
+    "/improve --pr_code_suggestions.summarize=true",
+]
+```
+Meaning that by default, for each PR the `describe`, `review`, and `improve` tools will be triggered automatically, and the `improve` tool will present the suggestions in a single comment.  
+You can of course overwrite these defaults by adding a `.pr_agent.toml` file to your repo. See [here](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app).
+
+### Jan 10, 2024
+[LanceDB](https://lancedb.com/) is now supported as a locally hosted VectorDB for the `similar_issue` tool. See [here](./docs/SIMILAR_ISSUE.md) for more details.
+
+
+## Overview
 <div style="text-align:left;">

 CodiumAI PR-Agent is an open-source tool to help efficiently review and handle pull requests. It automatically analyzes the pull request and can provide several types of commands:

+|       |                                                                                                                                          | GitHub | Gitlab | Bitbucket |
+|-------|------------------------------------------------------------------------------------------------------------------------------------------|:------:|:------:|:---------:|
+| TOOLS | Review                                                                                                                                   |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       |
+|       | ⮑ Incremental                                                                                                                            |   :white_check_mark:    |                         |                            |
+|       | ⮑ [SOC2 Compliance](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#soc2-ticket-compliance-) 💎                           |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
+|       | Describe                                                                                                                                 |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
+|       | ⮑ [Inline File Summary](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#inline-file-summary-) 💎                        |   :white_check_mark:    |       |          |
+|       | Improve                                                                                                                                  |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
+|       | ⮑ Extended                                                                                                                               |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
+|       | Ask                                                                                                                                      |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
+|       | [Custom Suggestions](https://github.com/Codium-ai/pr-agent/blob/main/docs/CUSTOM_SUGGESTIONS.md) 💎                                      |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
+|       | [Test](https://github.com/Codium-ai/pr-agent/blob/main/docs/TEST.md) 💎                                                                  |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
+|       | Reflect and Review                                                                                                                       |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
+|       | Update CHANGELOG.md                                                                                                                      |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
+|       | Find Similar Issue                                                                                                                       |   :white_check_mark:    |                         |                             |
+|       | [Add PR Documentation](https://github.com/Codium-ai/pr-agent/blob/main/docs/ADD_DOCUMENTATION.md) 💎                                     |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
+|       | [Custom Labels](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#handle-custom-labels-from-the-repos-labels-page-gem) 💎 |   :white_check_mark:    |   :white_check_mark:    |         |
+|       | [Analyze](https://github.com/Codium-ai/pr-agent/blob/main/docs/Analyze.md) 💎                                                            |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:      |
+|       |                                                                                                                                          |        |        |      |
+| USAGE | CLI                                                                                                                                      |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       |
+|       | App / webhook                                                                                                                            |   :white_check_mark:    |   :white_check_mark:    |  :white_check_mark:     |
+|       | Tagging bot                                                                                                                              |   :white_check_mark:    |        |           | 
+|       | Actions                                                                                                                                  |   :white_check_mark:    |        |  :white_check_mark:         | 
+|       |                                                                                                                                          |        |        |      |
+| CORE  | PR compression                                                                                                                           |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       |
+|       | Repo language prioritization                                                                                                             |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       |
+|       | Adaptive and token-aware<br />file patch fitting                                                                                         |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:     |
+|       | Multiple models support                                                                                                                  |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       | :white_check_mark: |
+|       | [Static code analysis](https://github.com/Codium-ai/pr-agent/blob/main/docs/Analyze.md) 💎                                               |   :white_check_mark:    |   :white_check_mark:     |    :white_check_mark:    |
+|       | [Global configuration](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#global-configuration-file-) 💎                           |   :white_check_mark:    |   :white_check_mark:     |    :white_check_mark:    |
+- 💎 means this feature is available only in [PR-Agent Pro](https://www.codium.ai/pricing/)
+- Support for additional git providers is described in [here](./docs/Full_environments.md)
+___
+
 ‣ **Auto Description ([`/describe`](./docs/DESCRIBE.md))**: Automatically generating PR description - title, type, summary, code walkthrough and labels.
 \
 ‣ **Auto Review ([`/review`](./docs/REVIEW.md))**: Adjustable feedback about the PR main theme, type, relevant tests, security issues, score, and various suggestions for the PR content.
@ -40,7 +112,10 @@ CodiumAI PR-Agent is an open-source tool to help efficiently review and handle p
 ‣ **Generate Custom Labels 💎 ([`/generate_labels`](./docs/GENERATE_CUSTOM_LABELS.md))**: Automatically suggests custom labels based on the PR code changes.
 \
 ‣ **Analyze 💎 ([`/analyze`](./docs/Analyze.md))**: Automatically analyzes the PR, and presents changes walkthrough for each component.
-
+\
+‣ **Custom Suggestions 💎 ([`/custom_suggestions`](./docs/CUSTOM_SUGGESTIONS.md))**: Automatically generates custom suggestions for improving the PR code, based on specific guidelines defined by the user.
+\
+‣ **Generate Tests 💎 ([`/test component_name`](./docs/TEST.md))**: Automatically generates unit tests for a selected component, based on the PR code changes.

 See the [Installation Guide](./INSTALL.md) for instructions on installing and running the tool on different git platforms.

@ -48,21 +123,13 @@ See the [Usage Guide](./Usage.md) for running the PR-Agent commands via differen

 See the [Tools Guide](./docs/TOOLS_GUIDE.md) for a detailed description of the different tools (tools are run via the commands).

-## Table of Contents
- [Example results](#example-results)
- [Features overview](#features-overview)
- [Try it now](#try-it-now)
- [Installation](#installation)
- [PR-Agent Pro 💎](#pr-agent-pro-)
- [How it works](#how-it-works)
- [Why use PR-Agent?](#why-use-pr-agent)

 ## Example results
 </div>
 <h4><a href="https://github.com/Codium-ai/pr-agent/pull/530">/describe</a></h4>
 <div align="center">
 <p float="center">
-<img src="https://www.codium.ai/images/pr_agent/describe_short_main.png" width="800">
+<img src="https://www.codium.ai/images/pr_agent/describe_new_short_main.png" width="800">
 </p>
 </div>
 <hr>
@ -125,40 +192,6 @@ See the [Tools Guide](./docs/TOOLS_GUIDE.md) for a detailed description of the d
 </div>
 <hr>

-## Features overview
-`PR-Agent` offers extensive pull request functionalities across various git providers:
-|       |                                             | GitHub | Gitlab | Bitbucket |
-|-------|---------------------------------------------|:------:|:------:|:---------:|
-| TOOLS | Review                                      |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       |
-|       | ⮑ Incremental                              |   :white_check_mark:    |                         |                            |
-|       | ⮑ [SOC2 Compliance](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#soc2-ticket-compliance-) 💎                       |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
-|       | Ask                                         |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
-|       | Describe                                    |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
-|       | Improve                                     |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
-|       | ⮑ Extended                                 |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
-|       | Reflect and Review                          |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
-|       | Update CHANGELOG.md                         |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
-|       | Find Similar Issue                          |   :white_check_mark:    |                         |                             |
-|       | [Add PR Documentation](https://github.com/Codium-ai/pr-agent/blob/main/docs/ADD_DOCUMENTATION.md) 💎                     |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
-|       | [Generate Custom Labels](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#handle-custom-labels-from-the-repos-labels-page-gem) 💎                   |   :white_check_mark:    |   :white_check_mark:    |         |
-|       | [Analyze PR Components](https://github.com/Codium-ai/pr-agent/blob/main/docs/Analyze.md) 💎                    |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:      |
-|       |                                             |        |        |      |
-| USAGE | CLI                                         |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       |
-|       | App / webhook                               |   :white_check_mark:    |   :white_check_mark:    |           |
-|       | Tagging bot                                 |   :white_check_mark:    |        |           | 
-|       | Actions                                     |   :white_check_mark:    |        |           | 
-|       |                                             |        |        |      |
-| CORE  | PR compression                              |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       |
-|       | Repo language prioritization                |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       |
-|       | Adaptive and token-aware<br />file patch fitting |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:     |
-|       | Multiple models support |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       | :white_check_mark: |
-|       | Incremental PR review |   :white_check_mark:    |      |      |
-|       | [Static code analysis](https://github.com/Codium-ai/pr-agent/blob/main/docs/Analyze.md) 💎 |   :white_check_mark:    |   :white_check_mark:     |    :white_check_mark:    |
-|       | [Global configuration](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#global-configuration-file-) 💎 |   :white_check_mark:    |   :white_check_mark:     |    :white_check_mark:    |
-
-
- 💎 means this feature is available only in [PR-Agent Pro](https://www.codium.ai/pricing/)
- Support for additional git providers is described in [here](./docs/Full_enviroments.md) 

 ## Try it now

--- a/Usage.md
+++ b/Usage.md
@ -142,28 +142,20 @@ num_code_suggestions=1
 Then you will overwrite the default number of code suggestions to 1.

 #### GitHub app automatic tools
-The [github_app](pr_agent/settings/configuration.toml#L76) section defines GitHub app-specific configurations.  
-In this section, you can define configurations to control the conditions for which tools will **run automatically**.  
+The [github_app](pr_agent/settings/configuration.toml#L108) section defines GitHub app specific configurations.  

-##### GitHub app automatic tools for PR actions
-The GitHub app can respond to the following actions on a PR:
-1. `opened` - Opening a new PR
-2. `reopened` - Reopening a closed PR
-3. `ready_for_review` - Moving a PR from Draft to Open
-4. `review_requested` - Specifically requesting review (in the PR reviewers list) from the `github-actions[bot]` user
-
-The configuration parameter `handle_pr_actions` defines the list of actions for which the GitHub app will trigger the PR-Agent.  
-The configuration parameter `pr_commands` defines the list of tools that will be **run automatically** when one of the above actions happens (e.g., a new PR is opened):
+##### GitHub app automatic tools for PR actions 
+The configuration parameter `pr_commands` defines the list of tools that will be **run automatically** when a new PR is opened.
 ```
 [github_app]
-handle_pr_actions = ['opened', 'reopened', 'ready_for_review', 'review_requested']
 pr_commands = [
    "/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
-    "/review",
+    "/review --pr_reviewer.num_code_suggestions=0",
+    "/improve",
 ]
 ```
-This means that when a new PR is opened/reopened or marked as ready for review, PR-Agent will run the `describe` and `review` tools.  
-For the `describe` tool, the `add_original_user_description` and `keep_original_user_title` parameters will be set to true.
+This means that when a new PR is opened/reopened or marked as ready for review, PR-Agent will run the `describe`, `review` and `improve` tools.  
+For the `describe` tool, for example, the `add_original_user_description` and `keep_original_user_title` parameters will be set to true.

 You can override the default tool parameters by uploading a local configuration file called `.pr_agent.toml` to the root of your repo.
 For example, if your local `.pr_agent.toml` file contains:
@ -180,7 +172,7 @@ To cancel the automatic run of all the tools, set:
 handle_pr_actions = []
 ```

-##### GitHub app automatic tools for new code (PR push)
+##### GitHub app automatic tools for push actions (commits to an open PR)
 In addition to running automatic tools when a PR is opened, the GitHub app can also respond to new code that is pushed to an open PR.

 The configuration toggle `handle_push_trigger` can be used to enable this feature.  
@ -217,18 +209,19 @@ user="""
 Note that the new prompt will need to generate an output compatible with the relevant [post-process function](./pr_agent/tools/pr_description.py#L137).

 ### Working with GitHub Action
-You can configure settings in GitHub action by adding environment variables under the env section in `.github/workflows/pr_agent.yml` file. 
+`GitHub Action` is a different way to trigger PR-Agent tools, and uses a different configuration mechanism than `GitHub App`.
+You can configure settings for `GitHub Action` by adding environment variables under the env section in `.github/workflows/pr_agent.yml` file. 
 Specifically, start by setting the following environment variables:
 ```yaml
      env:
        OPENAI_KEY: ${{ secrets.OPENAI_KEY }} # Make sure to add your OpenAI key to your repo secrets
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Make sure to add your GitHub token to your repo secrets
-        github_action.auto_review: "true" # enable\disable auto review
-        github_action.auto_describe: "true" # enable\disable auto describe
-        github_action.auto_improve: "false" # enable\disable auto improve
+        github_action_config.auto_review: "true" # enable\disable auto review
+        github_action_config.auto_describe: "true" # enable\disable auto describe
+        github_action_config.auto_improve: "true" # enable\disable auto improve
 ```
-`github_action.auto_review`, `github_action.auto_describe` and `github_action.auto_improve` are used to enable/disable automatic tools that run when a new PR is opened.
-If not set, the default option is that only the `review` tool will run automatically when a new PR is opened.
+`github_action_config.auto_review`, `github_action_config.auto_describe` and `github_action_config.auto_improve` are used to enable/disable automatic tools that run when a new PR is opened.
+If not set, the default configuration is for all three tools to run automatically when a new PR is opened.

 Note that you can give additional config parameters by adding environment variables to `.github/workflows/pr_agent.yml`, or by using a `.pr_agent.toml` file in the root of your repo, similar to the GitHub App usage.

--- a/docs/ASK.md
+++ b/docs/ASK.md
@ -1,11 +1,15 @@
 # ASK Tool

-The `ask` tool answers questions about the PR, based on the PR code changes.
+The `ask` tool answers questions about the PR, based on the PR code changes. Make sure to be specific and clear in your questions.
 It can be invoked manually by commenting on any PR:
 ```
 /ask "..."
 ```
 For example:
-
+___
 <kbd><img src=https://codium.ai/images/pr_agent/ask_comment.png width="768"></kbd>
-<kbd><img src=https://codium.ai/images/pr_agent/ask.png width="768"></kbd>
+___
+<kbd><img src=https://codium.ai/images/pr_agent/ask.png width="768"></kbd>
+___
+
+Note that the tool does not have "memory" of previous questions, and answers each question independently.
--- a/docs/CUSTOM_SUGGESTIONS.md
+++ b/docs/CUSTOM_SUGGESTIONS.md
@ -0,0 +1,65 @@
+# Custom Suggestions Tool 💎
+
+## Table of Contents
+- [Overview](#overview)
+- [Example usage](#example-usage)
+- [Configuration options](#configuration-options)
+
+
+## Overview
+The `custom_suggestions` tool scans the PR code changes, and automatically generates custom suggestions for improving the PR code.
+It shares similarities with the `improve` tool, but with one main difference: the `custom_suggestions` tool will only propose suggestions that follow specific guidelines defined by the prompt in: `pr_custom_suggestions.prompt` configuration.
+
+The tool can be triggered [automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on a PR.
+
+When commenting, use the following template:
+
+```
+/custom_suggestions --pr_custom_suggestions.prompt="The suggestions should focus only on the following:\n-...\n-...\n-..."
+```
+
+With a [configuration file](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), use the following template:
+
+```
+[pr_custom_suggestions]
+prompt="""\
+The suggestions should focus only on the following:
+-...
+-...
+-...
+"""
+```
+Using a configuration file is recommended, since it allows to use multi-line instructions.
+
+Don't forget - with this tool, you are the prompter. Be specific, clear, and concise in the instructions. Specify relevant aspects that you want the model to focus on. \
+You might benefit from several trial-and-error iterations, until you get the correct prompt for your use case.
+
+## Example usage
+
+Here is an example of a possible prompt:
+```
+[pr_custom_suggestions]
+prompt="""\
+The suggestions should focus only on the following:
+- look for edge cases when implementing a new function
+- make sure every variable has a meaningful name
+- make sure the code is efficient
+"""
+```     
+
+The instructions above are just an example. We want to emphasize that the prompt should be specific and clear, and be tailored to the needs of your project.
+
+Results obtained with the prompt above:
+___
+<kbd><img src=https://codium.ai/images/pr_agent/custom_suggestions_prompt.png width="512"></kbd>
+___
+<kbd><img src=https://codium.ai/images/pr_agent/custom_suggestions_result.png width="768"></kbd>
+___
+
+## Configuration options
+
+`prompt`: the prompt for the tool. It should be a multi-line string.
+
+`num_code_suggestions`: number of code suggestions provided by the 'custom_suggestions' tool. Default is 4.
+
+`enable_help_text`: if set to true, the tool will display a help text in the comment. Default is true.
--- a/docs/DESCRIBE.md
+++ b/docs/DESCRIBE.md
@ -2,6 +2,7 @@
 ## Table of Contents
 - [Overview](#overview)
  - [Configuration options](#configuration-options)
+  - [Inline file summary 💎](#inline-file-summary-)
  - [Handle custom labels from the Repo's labels page :gem:](#handle-custom-labels-from-the-repos-labels-page-gem)
  - [Markers template](#markers-template)
 - [Usage Tips](#usage-tips)
@ -19,7 +20,7 @@ For example:
 ___
 <kbd><img src=https://codium.ai/images/pr_agent/describe_comment.png width="768"></kbd>
 ___
-<kbd><img src=https://codium.ai/images/pr_agent/describe.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/describe_new.png width="768"></kbd>
 ___
  
 ### Configuration options
@ -48,6 +49,19 @@ To edit [configurations](./../pr_agent/settings/configuration.toml#L46) related
 - `enable_semantic_files_types`: if set to true, "Changes walkthrough" section will be generated. Default is true.
 - `collapsible_file_list`: if set to true, the file list in the "Changes walkthrough" section will be collapsible. If set to "adaptive", the file list will be collapsible only if there are more than 8 files. Default is "adaptive".
  
+### Inline file summary 💎
+> This feature is available only in PR-Agent Pro
+
+This will enable you to quickly understand the changes in each file, while reviewing the code changes (diff view).
+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.
+<kbd><img src=https://codium.ai/images/pr_agent/diffview-table.png width="1024"></kbd>
+- `true`: A collapsable file comment with changes title and a changes summary for each file in the PR.
+<kbd><img src=https://codium.ai/images/pr_agent/diffview_changes.png width="1024"></kbd>
+- `false` (`default`): File changes walkthrough will be added only to the "Conversation" tab.
+
+*Note that this feature is currently available only for GitHub.
+

 ### Handle custom labels from the Repo's labels page :gem:
 > This feature is available only in PR-Agent Pro 
@ -130,7 +144,7 @@ The default labels of the describe tool are quite generic, since they are meant

 If you specify [custom labels](#handle-custom-labels-from-the-repos-labels-page-gem) in the repo's labels page, you can get tailored labels for your use cases.
 Examples for custom labels:
- `Main topic:performence` -  pr_agent:The main topic of this PR is performance
+- `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
@ -138,4 +152,4 @@ Examples for custom labels:

 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.
-<br>Make sure to provide proper title, and detailed and well-phrased description for each label, so the tool will know when to suggest it.
+<br>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.
--- a/docs/Full_environments.md
+++ b/docs/Full_environments.md
--- a/docs/IMPROVE.md
+++ b/docs/IMPROVE.md
@ -10,21 +10,28 @@
    - [A note on code suggestions quality](#a-note-on-code-suggestions-quality)

 ## Overview
-The `improve` tool scans the PR code changes, and automatically generates committable suggestions for improving the PR code.
+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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools), or it can be invoked manually by commenting on any PR:
 ```
 /improve
 ```

-For example:
+### Summarized vs commitable code suggestions

-<kbd><img src=https://codium.ai/images/pr_agent/improve_comment.png width="768"></kbd>
-
---
+The code suggestions can be presented as a single comment (via `pr_code_suggestions.summarize=true`):
+___
+<kbd><img src=https://codium.ai/images/pr_agent/code_suggestions_as_comment.png width="768"></kbd>
+___

+Or as a separate commitable code comment for each suggestion:
+___
 <kbd><img src=https://codium.ai/images/pr_agent/improve.png width="768"></kbd>

 ---
+Note that a single comment has a significantly smaller PR footprint. We recommend this mode for most cases.
+Also note that collapsible are not supported in _Bitbucket_. Hence, the suggestions are presented there as code comments.
+
+### Extended mode

 An extended mode, which does not involve PR Compression and provides more comprehensive suggestions, can be invoked by commenting on any PR:
 ```
@ -44,8 +51,8 @@ To edit [configurations](./../pr_agent/settings/configuration.toml#L66) related
 - `num_code_suggestions`: number of code suggestions provided by the 'improve' tool. Default is 4.
 - `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
 - `rank_suggestions`: if set to true, the tool will rank the suggestions, based on importance. Default is false.
- `include_improved_code`: if set to true, the tool will include an improved code implementation in the suggestion. Default is true.
-
+- `summarize`: if set to true, the tool will display the suggestions in a single comment. Default is false.
+- `enable_help_text`: if set to true, the tool will display a help text in the comment. Default is true.
 #### params for '/improve --extended' mode
 - `auto_extended_mode`: enable extended mode automatically (no need for the `--extended` option). Default is false.
 - `num_code_suggestions_per_chunk`: number of code suggestions provided by the 'improve' tool, per chunk. Default is 8.
@ -53,19 +60,6 @@ To edit [configurations](./../pr_agent/settings/configuration.toml#L66) related
 - `max_number_of_calls`: maximum number of chunks. Default is 5.
 - `final_clip_factor`: factor to remove suggestions with low confidence. Default is 0.9.

-#### Summarize mode
-In this mode, instead of presenting committable suggestions, the different suggestions will be combined into a single compact comment, with significantly smaller PR footprint.
-
-To invoke the summarize mode, use the following command:
-```
-/improve --pr_code_suggestions.summarize=true
-```
-
-For example:
-
-<kbd><img src=https://codium.ai/images/pr_agent/improved_summerize_open.png width="768"></kbd>
-
-___

 ## Usage Tips

@ -79,7 +73,7 @@ Examples for extra instructions:
 [pr_code_suggestions] # /improve #
 extra_instructions="""
 Emphasize the following aspects:
- Does the code logic covers relevant edge cases?
+- Does the code logic cover relevant edge cases?
 - Is the code logic clear and easy to understand?
 - Is the code logic efficient?
 ...
@ -87,10 +81,6 @@ Emphasize the following aspects:
 ```
 Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

-### PR footprint - regular vs summarize mode
-The default mode of the `improve` tool provides committable suggestions. This mode as a high PR footprint, since each suggestion is a separate comment you need to resolve.
-If you prefer something more compact, use the [`summarize`](#summarize-mode) mode, which combines all the suggestions into a single comment.
-
 ### 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.
--- a/docs/REVIEW.md
+++ b/docs/REVIEW.md
@ -42,14 +42,14 @@ To edit [configurations](./../pr_agent/settings/configuration.toml#L19)  related
 - `require_score_review`: if set to true, the tool will add a section that scores the PR. Default is false.
 - `require_tests_review`: if set to true, the tool will add a section that checks if the PR contains tests. Default is true.
 - `require_security_review`: if set to true, the tool will add a section that checks if the PR contains security issues. Default is true.
- `require_estimate_effort_to_review`: if set to true, the tool will add a section that estimates thed effort needed to review the PR. Default is true.
+- `require_estimate_effort_to_review`: if set to true, the tool will add a section that estimates the effort needed to review the PR. Default is true.
 #### SOC2 ticket compliance 💎
 This sub-tool checks if the PR description properly contains a ticket to a project management system (e.g., Jira, Asana, Trello, etc.), as required by SOC2 compliance. If not, it will add a label to the PR: "Missing SOC2 ticket".
- `require_soc2_review`: If set to true, the SOC2 ticket checker sub-tool will be enabled. Default is false.
+- `require_soc2_ticket`: If set to true, the SOC2 ticket checker sub-tool will be enabled. Default is false.
 - `soc2_ticket_prompt`: The prompt for the SOC2 ticket review. Default is: `Does the PR description include a link to ticket in a project management system (e.g., Jira, Asana, Trello, etc.) ?`. Edit this field if your compliance requirements are different.
 #### Adding PR labels
 - `enable_review_labels_security`: if set to true, the tool will publish a 'possible security issue' label if it detects a security issue. Default is true.
- `enable_review_labels_effort`: if set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is false.
+- `enable_review_labels_effort`: if set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is true.

 ###  Incremental Mode
 Incremental review only considers changes since the last PR-Agent review. This can be useful when working on the PR in an iterative manner, and you want to focus on the changes since the last review instead of reviewing the entire PR again.
@ -103,7 +103,7 @@ The `review` tool provides a collection of possible feedbacks about a PR.
 It is recommended to review the [Configuration options](#configuration-options) section, and choose the relevant options 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_review`, `enable_review_labels_effort`, and more.
+`require_score_review`, `require_soc2_ticket`, and more.

 On the other hand, if you find one of the enabled features to be irrelevant for your use case, disable it. No default configuration can fit all use cases.

@ -122,14 +122,14 @@ 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 if it detects a [security issue](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`enable_review_labels_security` flag)
+- a `possible security issue` label that detects a possible [security issue](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`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)

 Both modes are useful, and we recommended to enable them.

 ### Extra instructions
 Extra instruction are important.
-The `review` tool can be configured with extra instructions, which can be used to guide the model to feedback tailored to the needs of your project.
+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.

@ -138,7 +138,7 @@ Examples for extra instructions:
 [pr_reviewer] # /review #
 extra_instructions="""
 In the code feedback section, emphasize the following:
- Does the code logic covers relevant edge cases?
+- Does the code logic cover relevant edge cases?
 - Is the code logic clear and easy to understand?
 - Is the code logic efficient?
 ...
--- a/docs/TEST.md
+++ b/docs/TEST.md
@ -0,0 +1,30 @@
+# Test Tool 💎
+By combining LLM abilities with static code analysis, the `test` tool  generate tests for a selected component, based on the PR code changes.
+It can be invoked manually by commenting on any PR:
+```
+/test component_name
+```
+where 'component_name' is the name of a specific component in the PR.
+To get a list of the components that changed in the PR, use the [`analyze`](https://github.com/Codium-ai/pr-agent/blob/main/docs/Analyze.md) tool.
+
+
+An example [result](https://github.com/Codium-ai/pr-agent/pull/598#issuecomment-1913679429):
+
+<kbd><img src=https://codium.ai/images/pr_agent/test1.png width="704"></kbd>
+___
+<kbd><img src=https://codium.ai/images/pr_agent/test2.png width="768"></kbd>
+___
+<kbd><img src=https://codium.ai/images/pr_agent/test3.png width="768"></kbd>
+
+Language that are currently supported by the tool: Python, Java, C++, JavaScript, TypeScript.
+
+
+
+### Configuration options
+- `num_tests`: number of tests to generate. Default is 3.
+- `testing_framework`: the testing framework to use. If not set, for Python it will use `pytest`, for Java it will use `JUnit`, for C++ it will use `Catch2`, and for JavaScript and TypeScript it will use `jest`.
+- `avoid_mocks`: if set to true, the tool will try to avoid using mocks in the generated tests. Note that even if this option is set to true, the tool might still use mocks if it cannot generate a test without them. Default is true.
+- `extra_instructions`: Optional extra instructions to the tool. For example: "use the following mock injection scheme: ...".
+- `file`: in case there are several components with the same name, you can specify the relevant file.
+- `class_name`: in case there are several methods with the same name in the same file, you can specify the relevant class name.
+- `enable_help_text`: if set to true, the tool will add a help text to the PR comment. Default is true.
--- a/docs/TOOLS_GUIDE.md
+++ b/docs/TOOLS_GUIDE.md
@ -5,8 +5,9 @@
 - [ASK](./ASK.md)
 - [SIMILAR_ISSUE](./SIMILAR_ISSUE.md)
 - [UPDATE CHANGELOG](./UPDATE_CHANGELOG.md)
- [ADD DOCUMENTATION](./ADD_DOCUMENTATION.md)
- [GENERATE CUSTOM LABELS](./GENERATE_CUSTOM_LABELS.md)
- [Analyze](./Analyze.md)
+- [ADD DOCUMENTATION](./ADD_DOCUMENTATION.md) 💎
+- [GENERATE CUSTOM LABELS](./GENERATE_CUSTOM_LABELS.md) 💎
+- [Analyze](./Analyze.md) 💎
+- [Test](./TEST.md) 💎

-See the **[installation guide](/INSTALL.md)** for instructions on how to setup PR-Agent.
+See the **[installation guide](/INSTALL.md)** for instructions on setting up PR-Agent.
--- a/pr_agent/algo/git_patch_processing.py
+++ b/pr_agent/algo/git_patch_processing.py
@ -181,7 +181,7 @@ __old hunk__
           ...
    """
    
-    patch_with_lines_str = f"\n\n## {file.filename}\n"
+    patch_with_lines_str = f"\n\n## file: '{file.filename.strip()}'\n"
    patch_lines = patch.splitlines()
    RE_HUNK_HEADER = re.compile(
        r"^@@ -(\d+)(?:,(\d+))? \+(\d+)(?:,(\d+))? @@[ ]?(.*)")
@ -202,11 +202,11 @@ __old hunk__
                if new_content_lines:
                    if prev_header_line:
                        patch_with_lines_str += f'\n{prev_header_line}\n'
-                    patch_with_lines_str += '__new hunk__\n'
+                    patch_with_lines_str = patch_with_lines_str.rstrip()+'\n__new hunk__\n'
                    for i, line_new in enumerate(new_content_lines):
                        patch_with_lines_str += f"{start2 + i} {line_new}\n"
                if old_content_lines:
-                    patch_with_lines_str += '__old hunk__\n'
+                    patch_with_lines_str = patch_with_lines_str.rstrip()+'\n__old hunk__\n'
                    for line_old in old_content_lines:
                        patch_with_lines_str += f"{line_old}\n"
                new_content_lines = []
@ -236,11 +236,11 @@ __old hunk__
    if match and new_content_lines:
        if new_content_lines:
            patch_with_lines_str += f'\n{header_line}\n'
-            patch_with_lines_str += '\n__new hunk__\n'
+            patch_with_lines_str = patch_with_lines_str.rstrip()+ '\n__new hunk__\n'
            for i, line_new in enumerate(new_content_lines):
                patch_with_lines_str += f"{start2 + i} {line_new}\n"
        if old_content_lines:
-            patch_with_lines_str += '\n__old hunk__\n'
+            patch_with_lines_str = patch_with_lines_str.rstrip() + '\n__old hunk__\n'
            for line_old in old_content_lines:
                patch_with_lines_str += f"{line_old}\n"

--- a/pr_agent/algo/pr_processing.py
+++ b/pr_agent/algo/pr_processing.py
@ -209,9 +209,9 @@ def pr_generate_compressed_diff(top_langs: list, token_handler: TokenHandler, mo

        if patch:
            if not convert_hunks_to_line_numbers:
-                patch_final = f"## {file.filename}\n\n{patch}\n"
+                patch_final = f"\n\n## file: '{file.filename.strip()}\n\n{patch.strip()}\n'"
            else:
-                patch_final = patch
+                patch_final = "\n\n" + patch.strip()
            patches.append(patch_final)
            total_tokens += token_handler.count_tokens(patch_final)
            if get_settings().config.verbosity_level >= 2:
@ -375,6 +375,13 @@ def get_pr_multi_diffs(git_provider: GitProvider,
    for lang in pr_languages:
        sorted_files.extend(sorted(lang['files'], key=lambda x: x.tokens, reverse=True))

+
+    # try first a single run with standard diff string, with patch extension, and no deletions
+    patches_extended, total_tokens, patches_extended_tokens = pr_generate_extended_diff(
+        pr_languages, token_handler, add_line_numbers_to_hunks=True)
+    if total_tokens + OUTPUT_BUFFER_TOKENS_SOFT_THRESHOLD < get_max_tokens(model):
+        return ["\n".join(patches_extended)]
+
    patches = []
    final_diff_list = []
    total_tokens = token_handler.prompt_tokens
--- a/pr_agent/algo/utils.py
+++ b/pr_agent/algo/utils.py
@ -116,7 +116,7 @@ def parse_code_suggestion(code_suggestions: dict, i: int = 0, gfm_supported: boo
                    relevant_line = sub_value_list[0].lstrip('`').lstrip('[')
                    if len(sub_value_list) > 1:
                        link = sub_value_list[1].rstrip(')').strip('`')
-                        markdown_text += f"<td><a href={link}>{relevant_line}</a></td>"
+                        markdown_text += f"<td><a href='{link}'>{relevant_line}</a></td>"
                    else:
                        markdown_text += f"<td>{relevant_line}</td>"
                    markdown_text += "</tr>"
@ -474,4 +474,13 @@ def clip_tokens(text: str, max_tokens: int, add_three_dots=True) -> str:
        return clipped_text
    except Exception as e:
        get_logger().warning(f"Failed to clip tokens: {e}")
-        return text
+        return text
+
+def replace_code_tags(text):
+    """
+    Replace odd instances of ` with <code> and even instances of ` with </code>
+    """
+    parts = text.split('`')
+    for i in range(1, len(parts), 2):
+        parts[i] = '<code>' + parts[i] + '</code>'
+    return ''.join(parts)
--- a/pr_agent/git_providers/azuredevops_provider.py
+++ b/pr_agent/git_providers/azuredevops_provider.py
@ -1,29 +1,40 @@
-import json
+import os
 from typing import Optional, Tuple
 from urllib.parse import urlparse

-import os
-
 from ..log import get_logger
+from ..algo.language_handler import is_valid_file
+from ..algo.utils import clip_tokens, load_large_diff
+from ..config_loader import get_settings
+from .git_provider import EDIT_TYPE, FilePatchInfo, GitProvider

 AZURE_DEVOPS_AVAILABLE = True
+
 try:
+    # noinspection PyUnresolvedReferences
    from msrest.authentication import BasicAuthentication
+    # noinspection PyUnresolvedReferences
    from azure.devops.connection import Connection
-    from azure.devops.v7_1.git.models import Comment, CommentThread, GitVersionDescriptor, GitPullRequest
+    # noinspection PyUnresolvedReferences
+    from azure.devops.v7_1.git.models import (
+        Comment,
+        CommentThread,
+        GitVersionDescriptor,
+        GitPullRequest,
+    )
 except ImportError:
    AZURE_DEVOPS_AVAILABLE = False

-from ..config_loader import get_settings
-from ..algo.utils import load_large_diff, clip_tokens
-from ..algo.language_handler import is_valid_file
-from .git_provider import EDIT_TYPE, FilePatchInfo

+class AzureDevopsProvider(GitProvider):

-class AzureDevopsProvider:
-    def __init__(self, pr_url: Optional[str] = None, incremental: Optional[bool] = False):
+    def __init__(
+            self, pr_url: Optional[str] = None, incremental: Optional[bool] = False
+    ):
        if not AZURE_DEVOPS_AVAILABLE:
-            raise ImportError("Azure DevOps provider is not available. Please install the required dependencies.")
+            raise ImportError(
+                "Azure DevOps provider is not available. Please install the required dependencies."
+            )

        self.azure_devops_client = self._get_azure_devops_client()

@ -37,9 +48,123 @@ class AzureDevopsProvider:
        if pr_url:
            self.set_pr(pr_url)

+    def publish_code_suggestions(self, code_suggestions: list) -> bool:
+        """
+        Publishes code suggestions as comments on the PR.
+        """
+        post_parameters_list = []
+        for suggestion in code_suggestions:
+            body = suggestion['body']
+            relevant_file = suggestion['relevant_file']
+            relevant_lines_start = suggestion['relevant_lines_start']
+            relevant_lines_end = suggestion['relevant_lines_end']
+
+            if not relevant_lines_start or relevant_lines_start == -1:
+                if get_settings().config.verbosity_level >= 2:
+                    get_logger().exception(
+                        f"Failed to publish code suggestion, relevant_lines_start is {relevant_lines_start}")
+                continue
+
+            if relevant_lines_end < relevant_lines_start:
+                if get_settings().config.verbosity_level >= 2:
+                    get_logger().exception(f"Failed to publish code suggestion, "
+                                           f"relevant_lines_end is {relevant_lines_end} and "
+                                           f"relevant_lines_start is {relevant_lines_start}")
+                continue
+
+            if relevant_lines_end > relevant_lines_start:
+                post_parameters = {
+                    "body": body,
+                    "path": relevant_file,
+                    "line": relevant_lines_end,
+                    "start_line": relevant_lines_start,
+                    "start_side": "RIGHT",
+                }
+            else:  # API is different for single line comments
+                post_parameters = {
+                    "body": body,
+                    "path": relevant_file,
+                    "line": relevant_lines_start,
+                    "side": "RIGHT",
+                }
+            post_parameters_list.append(post_parameters)
+
+        try:
+            for post_parameters in post_parameters_list:
+                comment = Comment(content=post_parameters["body"], comment_type=1)
+                thread = CommentThread(comments=[comment],
+                                       thread_context={
+                                           "filePath": post_parameters["path"],
+                                           "rightFileStart": {
+                                               "line": post_parameters["start_line"],
+                                               "offset": 1,
+                                           },
+                                           "rightFileEnd": {
+                                               "line": post_parameters["line"],
+                                               "offset": 1,
+                                           },
+                                       })
+                self.azure_devops_client.create_thread(
+                    comment_thread=thread,
+                    project=self.workspace_slug,
+                    repository_id=self.repo_slug,
+                    pull_request_id=self.pr_num
+                )
+                if get_settings().config.verbosity_level >= 2:
+                    get_logger().info(
+                        f"Published code suggestion on {self.pr_num} at {post_parameters['path']}"
+                    )
+            return True
+        except Exception as e:
+            if get_settings().config.verbosity_level >= 2:
+                get_logger().error(f"Failed to publish code suggestion, error: {e}")
+            return False
+
+    def get_pr_description_full(self) -> str:
+        return self.pr.description
+
+    def remove_comment(self, comment):
+        try:
+            self.azure_devops_client.delete_comment(
+                repository_id=self.repo_slug,
+                pull_request_id=self.pr_num,
+                thread_id=comment["thread_id"],
+                comment_id=comment["comment_id"],
+                project=self.workspace_slug,
+            )
+        except Exception as e:
+            get_logger().exception(f"Failed to remove comment, error: {e}")
+
+    def publish_labels(self, pr_types):
+        try:
+            for pr_type in pr_types:
+                self.azure_devops_client.create_pull_request_label(
+                    label={"name": pr_type},
+                    project=self.workspace_slug,
+                    repository_id=self.repo_slug,
+                    pull_request_id=self.pr_num,
+                )
+        except Exception as e:
+            get_logger().exception(f"Failed to publish labels, error: {e}")
+
+    def get_pr_labels(self):
+        try:
+            labels = self.azure_devops_client.get_pull_request_labels(
+                project=self.workspace_slug,
+                repository_id=self.repo_slug,
+                pull_request_id=self.pr_num,
+            )
+            return [label.name for label in labels]
+        except Exception as e:
+            get_logger().exception(f"Failed to get labels, error: {e}")
+            return []
+
    def is_supported(self, capability: str) -> bool:
-        if capability in ['get_issue_comments', 'create_inline_comment', 'publish_inline_comments', 'get_labels',
-                          'remove_initial_comment', 'gfm_markdown']:
+        if capability in [
+            "get_issue_comments",
+            "create_inline_comment",
+            "publish_inline_comments",
+        ]:
            return False
        return True

@ -49,26 +174,35 @@ class AzureDevopsProvider:

    def get_repo_settings(self):
        try:
-            contents = self.azure_devops_client.get_item_content(repository_id=self.repo_slug,
-                                                                 project=self.workspace_slug, download=False,
-                                                                 include_content_metadata=False, include_content=True,
-                                                                 path=".pr_agent.toml")
+            contents = self.azure_devops_client.get_item_content(
+                repository_id=self.repo_slug,
+                project=self.workspace_slug,
+                download=False,
+                include_content_metadata=False,
+                include_content=True,
+                path=".pr_agent.toml",
+            )
            return contents
        except Exception as e:
-            get_logger().exception("get repo settings error")
+            if get_settings().config.verbosity_level >= 2:
+                get_logger().error(f"Failed to get repo settings, error: {e}")
            return ""

    def get_files(self):
        files = []
-        for i in self.azure_devops_client.get_pull_request_commits(project=self.workspace_slug,
-                                                                   repository_id=self.repo_slug,
-                                                                   pull_request_id=self.pr_num):
-
-            changes_obj = self.azure_devops_client.get_changes(project=self.workspace_slug,
-                                                               repository_id=self.repo_slug, commit_id=i.commit_id)
+        for i in self.azure_devops_client.get_pull_request_commits(
+                project=self.workspace_slug,
+                repository_id=self.repo_slug,
+                pull_request_id=self.pr_num,
+        ):
+            changes_obj = self.azure_devops_client.get_changes(
+                project=self.workspace_slug,
+                repository_id=self.repo_slug,
+                commit_id=i.commit_id,
+            )

            for c in changes_obj.changes:
-                files.append(c['item']['path'])
+                files.append(c["item"]["path"])
        return list(set(files))

    def get_diff_files(self) -> list[FilePatchInfo]:
@ -76,22 +210,27 @@ class AzureDevopsProvider:
            base_sha = self.pr.last_merge_target_commit
            head_sha = self.pr.last_merge_source_commit

-            commits = self.azure_devops_client.get_pull_request_commits(project=self.workspace_slug,
-                                                                        repository_id=self.repo_slug,
-                                                                        pull_request_id=self.pr_num)
+            commits = self.azure_devops_client.get_pull_request_commits(
+                project=self.workspace_slug,
+                repository_id=self.repo_slug,
+                pull_request_id=self.pr_num,
+            )

            diff_files = []
            diffs = []
            diff_types = {}

            for c in commits:
-                changes_obj = self.azure_devops_client.get_changes(project=self.workspace_slug,
-                                                                   repository_id=self.repo_slug, commit_id=c.commit_id)
+                changes_obj = self.azure_devops_client.get_changes(
+                    project=self.workspace_slug,
+                    repository_id=self.repo_slug,
+                    commit_id=c.commit_id,
+                )
                for i in changes_obj.changes:
-                    if(i['item']['gitObjectType'] == 'tree'):
+                    if i["item"]["gitObjectType"] == "tree":
                        continue
-                    diffs.append(i['item']['path'])
-                    diff_types[i['item']['path']] = i['changeType']
+                    diffs.append(i["item"]["path"])
+                    diff_types[i["item"]["path"]] = i["changeType"]

            diffs = list(set(diffs))

@ -99,49 +238,73 @@ class AzureDevopsProvider:
                if not is_valid_file(file):
                    continue

-                version = GitVersionDescriptor(version=head_sha.commit_id, version_type='commit')
+                version = GitVersionDescriptor(
+                    version=head_sha.commit_id, version_type="commit"
+                )
                try:
-                    new_file_content_str = self.azure_devops_client.get_item(repository_id=self.repo_slug,
-                                                                            path=file,
-                                                                            project=self.workspace_slug,
-                                                                            version_descriptor=version,
-                                                                            download=False,
-                                                                            include_content=True)
+                    new_file_content_str = self.azure_devops_client.get_item(
+                        repository_id=self.repo_slug,
+                        path=file,
+                        project=self.workspace_slug,
+                        version_descriptor=version,
+                        download=False,
+                        include_content=True,
+                    )

                    new_file_content_str = new_file_content_str.content
                except Exception as error:
-                    get_logger().error("Failed to retrieve new file content of %s at version %s. Error: %s", file, version, str(error))
+                    get_logger().error(
+                        "Failed to retrieve new file content of %s at version %s. Error: %s",
+                        file,
+                        version,
+                        str(error),
+                    )
                    new_file_content_str = ""

                edit_type = EDIT_TYPE.MODIFIED
-                if diff_types[file] == 'add':
+                if diff_types[file] == "add":
                    edit_type = EDIT_TYPE.ADDED
-                elif diff_types[file] == 'delete':
+                elif diff_types[file] == "delete":
                    edit_type = EDIT_TYPE.DELETED
-                elif diff_types[file] == 'rename':
+                elif diff_types[file] == "rename":
                    edit_type = EDIT_TYPE.RENAMED

-                version = GitVersionDescriptor(version=base_sha.commit_id, version_type='commit')
+                version = GitVersionDescriptor(
+                    version=base_sha.commit_id, version_type="commit"
+                )
                try:
-                    original_file_content_str = self.azure_devops_client.get_item(repository_id=self.repo_slug,
-                                                                              path=file,
-                                                                              project=self.workspace_slug,
-                                                                              version_descriptor=version,
-                                                                              download=False,
-                                                                              include_content=True)
+                    original_file_content_str = self.azure_devops_client.get_item(
+                        repository_id=self.repo_slug,
+                        path=file,
+                        project=self.workspace_slug,
+                        version_descriptor=version,
+                        download=False,
+                        include_content=True,
+                    )
                    original_file_content_str = original_file_content_str.content
                except Exception as error:
-                    get_logger().error("Failed to retrieve original file content of %s at version %s. Error: %s", file, version, str(error))
+                    get_logger().error(
+                        "Failed to retrieve original file content of %s at version %s. Error: %s",
+                        file,
+                        version,
+                        str(error),
+                    )
                    original_file_content_str = ""

-                patch = load_large_diff(file, new_file_content_str, original_file_content_str)
+                patch = load_large_diff(
+                    file, new_file_content_str, original_file_content_str
+                )

-                diff_files.append(FilePatchInfo(original_file_content_str, new_file_content_str,
-                                                patch=patch,
-                                                filename=file,
-                                                edit_type=edit_type))
+                diff_files.append(
+                    FilePatchInfo(
+                        original_file_content_str,
+                        new_file_content_str,
+                        patch=patch,
+                        filename=file,
+                        edit_type=edit_type,
+                    )
+                )

-            self.diff_files = diff_files
            return diff_files
        except Exception as e:
            print(f"Error: {str(e)}")
@ -150,64 +313,92 @@ class AzureDevopsProvider:
    def publish_comment(self, pr_comment: str, is_temporary: bool = False):
        comment = Comment(content=pr_comment)
        thread = CommentThread(comments=[comment])
-        thread_response = self.azure_devops_client.create_thread(comment_thread=thread, project=self.workspace_slug,
-                                                                 repository_id=self.repo_slug,
-                                                                 pull_request_id=self.pr_num)
+        thread_response = self.azure_devops_client.create_thread(
+            comment_thread=thread,
+            project=self.workspace_slug,
+            repository_id=self.repo_slug,
+            pull_request_id=self.pr_num,
+        )
        if is_temporary:
-            self.temp_comments.append({'thread_id': thread_response.id, 'comment_id': comment.id})
+            self.temp_comments.append(
+                {"thread_id": thread_response.id, "comment_id": thread_response.comments[0].id}
+            )

    def publish_description(self, pr_title: str, pr_body: str):
        try:
            updated_pr = GitPullRequest()
            updated_pr.title = pr_title
            updated_pr.description = pr_body
-            self.azure_devops_client.update_pull_request(project=self.workspace_slug,
-                                                         repository_id=self.repo_slug,
-                                                         pull_request_id=self.pr_num,
-                                                         git_pull_request_to_update=updated_pr)
+            self.azure_devops_client.update_pull_request(
+                project=self.workspace_slug,
+                repository_id=self.repo_slug,
+                pull_request_id=self.pr_num,
+                git_pull_request_to_update=updated_pr,
+            )
        except Exception as e:
-            get_logger().exception(f"Could not update pull request {self.pr_num} description: {e}")
+            get_logger().exception(
+                f"Could not update pull request {self.pr_num} description: {e}"
+            )

    def remove_initial_comment(self):
-        return ""  # not implemented yet
+        try:
+            for comment in self.temp_comments:
+                self.remove_comment(comment)
+        except Exception as e:
+            get_logger().exception(f"Failed to remove temp comments, error: {e}")

-    def publish_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
-        raise NotImplementedError("Azure DevOps provider does not support publishing inline comment yet")
+    def publish_inline_comment(
+            self, body: str, relevant_file: str, relevant_line_in_file: str
+    ):
+        raise NotImplementedError(
+            "Azure DevOps provider does not support publishing inline comment yet"
+        )

    def publish_inline_comments(self, comments: list[dict]):
-        raise NotImplementedError("Azure DevOps provider does not support publishing inline comments yet")
+        raise NotImplementedError(
+            "Azure DevOps provider does not support publishing inline comments yet"
+        )

    def get_title(self):
        return self.pr.title

    def get_languages(self):
        languages = []
-        files = self.azure_devops_client.get_items(project=self.workspace_slug, repository_id=self.repo_slug,
-                                                   recursion_level="Full", include_content_metadata=True,
-                                                   include_links=False, download=False)
+        files = self.azure_devops_client.get_items(
+            project=self.workspace_slug,
+            repository_id=self.repo_slug,
+            recursion_level="Full",
+            include_content_metadata=True,
+            include_links=False,
+            download=False,
+        )
        for f in files:
-            if f.git_object_type == 'blob':
+            if f.git_object_type == "blob":
                file_name, file_extension = os.path.splitext(f.path)
                languages.append(file_extension[1:])

        extension_counts = {}
        for ext in languages:
-            if ext != '':
+            if ext != "":
                extension_counts[ext] = extension_counts.get(ext, 0) + 1

        total_extensions = sum(extension_counts.values())

-        extension_percentages = {ext: (count / total_extensions) * 100 for ext, count in extension_counts.items()}
+        extension_percentages = {
+            ext: (count / total_extensions) * 100
+            for ext, count in extension_counts.items()
+        }

        return extension_percentages

    def get_pr_branch(self):
-        pr_info = self.azure_devops_client.get_pull_request_by_id(project=self.workspace_slug,
-                                                                  pull_request_id=self.pr_num)
-        source_branch = pr_info.source_ref_name.split('/')[-1]
+        pr_info = self.azure_devops_client.get_pull_request_by_id(
+            project=self.workspace_slug, pull_request_id=self.pr_num
+        )
+        source_branch = pr_info.source_ref_name.split("/")[-1]
        return source_branch

-    def get_pr_description(self):
+    def get_pr_description(self, *, full: bool = True) -> str:
        max_tokens = get_settings().get("CONFIG.MAX_DESCRIPTION_TOKENS", None)
        if max_tokens:
            return clip_tokens(self.pr.description, max_tokens)
@ -217,7 +408,9 @@ class AzureDevopsProvider:
        return 0

    def get_issue_comments(self):
-        raise NotImplementedError("Azure DevOps provider does not support issue comments yet")
+        raise NotImplementedError(
+            "Azure DevOps provider does not support issue comments yet"
+        )

    def add_eyes_reaction(self, issue_comment_id: int) -> Optional[int]:
        return True
@ -225,17 +418,16 @@ class AzureDevopsProvider:
    def remove_reaction(self, issue_comment_id: int, reaction_id: int) -> bool:
        return True

-    def get_issue_comments(self):
-        raise NotImplementedError("Azure DevOps provider does not support issue comments yet")
-
    @staticmethod
-    def _parse_pr_url(pr_url: str) -> Tuple[str, int]:
+    def _parse_pr_url(pr_url: str) -> Tuple[str, str, int]:
        parsed_url = urlparse(pr_url)

-        path_parts = parsed_url.path.strip('/').split('/')
+        path_parts = parsed_url.path.strip("/").split("/")

-        if len(path_parts) < 6 or path_parts[4] != 'pullrequest':
-            raise ValueError("The provided URL does not appear to be a Azure DevOps PR URL")
+        if len(path_parts) < 6 or path_parts[4] != "pullrequest":
+            raise ValueError(
+                "The provided URL does not appear to be a Azure DevOps PR URL"
+            )

        workspace_slug = path_parts[1]
        repo_slug = path_parts[3]
@ -246,15 +438,15 @@ class AzureDevopsProvider:

        return workspace_slug, repo_slug, pr_number

-    def _get_azure_devops_client(self):
+    @staticmethod
+    def _get_azure_devops_client():
        try:
            pat = get_settings().azure_devops.pat
            org = get_settings().azure_devops.org
        except AttributeError as e:
-            raise ValueError(
-                "Azure DevOps PAT token is required ") from e
+            raise ValueError("Azure DevOps PAT token is required ") from e

-        credentials = BasicAuthentication('', pat)
+        credentials = BasicAuthentication("", pat)
        azure_devops_connection = Connection(base_url=org, creds=credentials)
        azure_devops_client = azure_devops_connection.clients.get_git_client()

@ -262,13 +454,25 @@ class AzureDevopsProvider:

    def _get_repo(self):
        if self.repo is None:
-            self.repo = self.azure_devops_client.get_repository(project=self.workspace_slug,
-                                                                repository_id=self.repo_slug)
+            self.repo = self.azure_devops_client.get_repository(
+                project=self.workspace_slug, repository_id=self.repo_slug
+            )
        return self.repo

    def _get_pr(self):
-        self.pr = self.azure_devops_client.get_pull_request_by_id(pull_request_id=self.pr_num, project=self.workspace_slug)
+        self.pr = self.azure_devops_client.get_pull_request_by_id(
+            pull_request_id=self.pr_num, project=self.workspace_slug
+        )
        return self.pr

    def get_commit_messages(self):
        return ""  # not implemented yet
+
+    def get_pr_id(self):
+        try:
+            pr_id = f"{self.workspace_slug}/{self.repo_slug}/{self.pr_num}"
+            return pr_id
+        except Exception as e:
+            if get_settings().config.verbosity_level >= 2:
+                get_logger().error(f"Failed to get pr id, error: {e}")
+            return ""
--- a/pr_agent/git_providers/git_provider.py
+++ b/pr_agent/git_providers/git_provider.py
@ -75,15 +75,18 @@ class GitProvider(ABC):
    def get_user_description(self) -> str:
        description = (self.get_pr_description_full() or "").strip()
        description_lowercase = description.lower()
+        get_logger().info(f"Existing description:\n{description_lowercase}")

        # if the existing description wasn't generated by the pr-agent, just return it as-is
        if not self._is_generated_by_pr_agent(description_lowercase):
+            get_logger().info(f"Existing description was not generated by the pr-agent")
            return description

        # if the existing description was generated by the pr-agent, but it doesn't contain a user description,
        # return nothing (empty string) because it means there is no user description
-        user_description_header = "## user description"
+        user_description_header = "## **user description**"
        if user_description_header not in description_lowercase:
+            get_logger().info(f"Existing description was generated by the pr-agent, but it doesn't contain a user description")
            return ""

        # otherwise, extract the original user description from the existing pr-agent description and return it
@ -106,11 +109,12 @@ class GitProvider(ABC):
            if original_user_description.lower().startswith(user_description_header):
                original_user_description = original_user_description[len(user_description_header):].strip()

+        get_logger().info(f"Extracted user description from existing description:\n{original_user_description}")
        return original_user_description

    def _possible_headers(self):
-        return ("## user description", "## pr type", "## pr description", "## pr labels", "## type", "## description",
-                "## labels", "### 🤖 generated by pr agent")
+        return ("## **user description**", "## **pr type**", "## **pr description**", "## **pr labels**", "## **type**", "## **description**",
+                "## **labels**", "### 🤖 generated by pr agent")

    def _is_generated_by_pr_agent(self, description_lowercase: str) -> bool:
        possible_headers = self._possible_headers()
--- a/pr_agent/git_providers/github_provider.py
+++ b/pr_agent/git_providers/github_provider.py
@ -1,3 +1,4 @@
+import time
 import hashlib
 from datetime import datetime
 from typing import Optional, Tuple
@ -221,8 +222,114 @@ class GithubProvider(GitProvider):
        path = relevant_file.strip()
        return dict(body=body, path=path, position=position) if subject_type == "LINE" else {}

-    def publish_inline_comments(self, comments: list[dict]):
-        self.pr.create_review(commit=self.last_commit_id, comments=comments)
+    def publish_inline_comments(self, comments: list[dict], disable_fallback: bool = False):
+        try:
+            # publish all comments in a single message
+            self.pr.create_review(commit=self.last_commit_id, comments=comments)
+        except Exception as e:
+            if get_settings().config.verbosity_level >= 2:
+                get_logger().error(f"Failed to publish inline comments")
+
+            if (getattr(e, "status", None) == 422
+                    and get_settings().github.publish_inline_comments_fallback_with_verification and not disable_fallback):
+                pass  # continue to try _publish_inline_comments_fallback_with_verification
+            else:
+                raise e # will end up with publishing the comments one by one
+
+            try:
+                self._publish_inline_comments_fallback_with_verification(comments)
+            except Exception as e:
+                if get_settings().config.verbosity_level >= 2:
+                    get_logger().error(f"Failed to publish inline code comments fallback, error: {e}")
+                raise e
+
+    def _publish_inline_comments_fallback_with_verification(self, comments: list[dict]):
+        """
+        Check each inline comment separately against the GitHub API and discard of invalid comments,
+        then publish all the remaining valid comments in a single review.
+        For invalid comments, also try removing the suggestion part and posting the comment just on the first line.
+        """
+        verified_comments, invalid_comments = self._verify_code_comments(comments)
+
+        # publish as a group the verified comments
+        if verified_comments:
+            try:
+                self.pr.create_review(commit=self.last_commit_id, comments=verified_comments)
+            except:
+                pass
+
+        # try to publish one by one the invalid comments as a one-line code comment
+        if invalid_comments and get_settings().github.try_fix_invalid_inline_comments:
+            fixed_comments_as_one_liner = self._try_fix_invalid_inline_comments(
+                [comment for comment, _ in invalid_comments])
+            for comment in fixed_comments_as_one_liner:
+                try:
+                    self.publish_inline_comments([comment], disable_fallback=True)
+                    if get_settings().config.verbosity_level >= 2:
+                        get_logger().info(f"Published invalid comment as a single line comment: {comment}")
+                except:
+                    if get_settings().config.verbosity_level >= 2:
+                        get_logger().error(f"Failed to publish invalid comment as a single line comment: {comment}")
+
+    def _verify_code_comment(self, comment: dict):
+        is_verified = False
+        e = None
+        try:
+            # event ="" # By leaving this blank, you set the review action state to PENDING
+            input = dict(commit_id=self.last_commit_id.sha, comments=[comment])
+            headers, data = self.pr._requester.requestJsonAndCheck(
+                "POST", f"{self.pr.url}/reviews", input=input)
+            pending_review_id = data["id"]
+            is_verified = True
+        except Exception as err:
+            is_verified = False
+            pending_review_id = None
+            e = err
+        if pending_review_id is not None:
+            try:
+                self.pr._requester.requestJsonAndCheck("DELETE", f"{self.pr.url}/reviews/{pending_review_id}")
+            except Exception:
+                pass
+        return is_verified, e
+
+    def _verify_code_comments(self, comments: list[dict]) -> tuple[list[dict], list[tuple[dict, Exception]]]:
+        """Very each comment against the GitHub API and return 2 lists: 1 of verified and 1 of invalid comments"""
+        verified_comments = []
+        invalid_comments = []
+        for comment in comments:
+            time.sleep(1)  # for avoiding secondary rate limit
+            is_verified, e = self._verify_code_comment(comment)
+            if is_verified:
+                verified_comments.append(comment)
+            else:
+                invalid_comments.append((comment, e))
+        return verified_comments, invalid_comments
+
+    def _try_fix_invalid_inline_comments(self, invalid_comments: list[dict]) -> list[dict]:
+        """
+        Try fixing invalid comments by removing the suggestion part and setting the comment just on the first line.
+        Return only comments that have been modified in some way.
+        This is a best-effort attempt to fix invalid comments, and should be verified accordingly.
+        """
+        import copy
+        fixed_comments = []
+        for comment in invalid_comments:
+            try:
+                fixed_comment = copy.deepcopy(comment)  # avoid modifying the original comment dict for later logging
+                if "```suggestion" in comment["body"]:
+                    fixed_comment["body"] = comment["body"].split("```suggestion")[0]
+                if "start_line" in comment:
+                    fixed_comment["line"] = comment["start_line"]
+                    del fixed_comment["start_line"]
+                if "start_side" in comment:
+                    fixed_comment["side"] = comment["start_side"]
+                    del fixed_comment["start_side"]
+                if fixed_comment != comment:
+                    fixed_comments.append(fixed_comment)
+            except Exception as e:
+                if get_settings().config.verbosity_level >= 2:
+                    get_logger().error(f"Failed to fix inline comment, error: {e}")
+        return fixed_comments

    def publish_code_suggestions(self, code_suggestions: list) -> bool:
        """
@ -266,7 +373,7 @@ class GithubProvider(GitProvider):
            post_parameters_list.append(post_parameters)

        try:
-            self.pr.create_review(commit=self.last_commit_id, comments=post_parameters_list)
+            self.publish_inline_comments(post_parameters_list)
            return True
        except Exception as e:
            if get_settings().config.verbosity_level >= 2:
--- a/pr_agent/git_providers/gitlab_provider.py
+++ b/pr_agent/git_providers/gitlab_provider.py
@ -440,11 +440,11 @@ class GitLabProvider(GitProvider):

    def get_line_link(self, relevant_file: str, relevant_line_start: int, relevant_line_end: int = None) -> str:
        if relevant_line_start == -1:
-            link = f"https://gitlab.com/codiumai/pr-agent/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads"
+            link = f"{self.gl.url}/{self.id_project}/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads"
        elif relevant_line_end:
-            link = f"https://gitlab.com/codiumai/pr-agent/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads#L{relevant_line_start}-L{relevant_line_end}"
+            link = f"{self.gl.url}/{self.id_project}/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads#L{relevant_line_start}-L{relevant_line_end}"
        else:
-            link = f"https://gitlab.com/codiumai/pr-agent/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads#L{relevant_line_start}"
+            link = f"{self.gl.url}/{self.id_project}/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads#L{relevant_line_start}"
        return link


@ -460,7 +460,7 @@ class GitLabProvider(GitProvider):

            if absolute_position != -1:
                # link to right file only
-                link = f"https://gitlab.com/codiumai/pr-agent/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads#L{absolute_position}"
+                link = f"{self.gl.url}/{self.id_project}/-/blob/{self.mr.source_branch}/{relevant_file}?ref_type=heads#L{absolute_position}"

                # # link to diff
                # sha_file = hashlib.sha1(relevant_file.encode('utf-8')).hexdigest()
--- a/pr_agent/servers/github_action_runner.py
+++ b/pr_agent/servers/github_action_runner.py
@ -82,14 +82,23 @@ async def run_action():
        if action in ["opened", "reopened"]:
            pr_url = event_payload.get("pull_request", {}).get("url")
            if pr_url:
+                # legacy - supporting both GITHUB_ACTION and GITHUB_ACTION_CONFIG
                auto_review = get_setting_or_env("GITHUB_ACTION.AUTO_REVIEW", None)
+                if auto_review is None:
+                    auto_review = get_setting_or_env("GITHUB_ACTION_CONFIG.AUTO_REVIEW", None)
+                auto_describe = get_setting_or_env("GITHUB_ACTION.AUTO_DESCRIBE", None)
+                if auto_describe is None:
+                    auto_describe = get_setting_or_env("GITHUB_ACTION_CONFIG.AUTO_DESCRIBE", None)
+                auto_improve = get_setting_or_env("GITHUB_ACTION.AUTO_IMPROVE", None)
+                if auto_improve is None:
+                    auto_improve = get_setting_or_env("GITHUB_ACTION_CONFIG.AUTO_IMPROVE", None)
+
+                # invoke by default all three tools
+                if auto_describe is None or is_true(auto_describe):
+                    await PRDescription(pr_url).run()
                if auto_review is None or is_true(auto_review):
                    await PRReviewer(pr_url).run()
-                auto_describe = get_setting_or_env("GITHUB_ACTION.AUTO_DESCRIBE", None)
-                if is_true(auto_describe):
-                    await PRDescription(pr_url).run()
-                auto_improve = get_setting_or_env("GITHUB_ACTION.AUTO_IMPROVE", None)
-                if is_true(auto_improve):
+                if auto_improve is None or is_true(auto_improve):
                    await PRCodeSuggestions(pr_url).run()

    # Handle issue comment event
--- a/pr_agent/servers/github_polling.py
+++ b/pr_agent/servers/github_polling.py
@ -7,7 +7,6 @@ from pr_agent.agent.pr_agent import PRAgent
 from pr_agent.config_loader import get_settings
 from pr_agent.git_providers import get_git_provider
 from pr_agent.log import LoggingFormat, get_logger, setup_logger
-from pr_agent.servers.help import bot_help_text

 setup_logger(fmt=LoggingFormat.JSON)
 NOTIFICATION_URL = "https://api.github.com/notifications"
@ -104,8 +103,6 @@ async def polling_loop():
                                                                                 notify=lambda: git_provider.add_eyes_reaction(comment_id))  # noqa E501
                                            if not success:
                                                git_provider.set_pr(pr_url)
-                                                git_provider.publish_comment("### How to use PR-Agent\n" +
-                                                                             bot_help_text(user_id))

                    elif response.status != 304:
                        print(f"Failed to fetch notifications. Status code: {response.status}")
--- a/pr_agent/servers/help.py
+++ b/pr_agent/servers/help.py
@ -1,4 +1,7 @@
-commands_text = "> - **/review**: Request a review of your Pull Request.   \n" \
+class HelpMessage:
+    @staticmethod
+    def get_general_commands_text():
+       commands_text = "> - **/review**: Request a review of your Pull Request.   \n" \
                "> - **/describe**: Update the PR title and description based on the contents of the PR.   \n" \
                "> - **/improve [--extended]**: Suggest code improvements. Extended mode provides a higher quality feedback.   \n" \
                "> - **/ask \\<QUESTION\\>**: Ask a question about the PR.   \n" \
@ -7,14 +10,319 @@ commands_text = "> - **/review**: Request a review of your Pull Request.   \n" \
                "> - **/generate_labels** 💎: Generate labels for the PR based on the PR's contents.   \n" \
                "> - **/analyze** 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.   \n\n" \
                ">See the [tools guide](https://github.com/Codium-ai/pr-agent/blob/main/docs/TOOLS_GUIDE.md) for more details.\n" \
-                ">To edit any configuration parameter from the [configuration.toml](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml), add --config_path=new_value.  \n" \
-                ">For example: /review --pr_reviewer.extra_instructions=\"focus on the file: ...\"    \n" \
-                ">To list the possible configuration parameters, add a **/config** comment.   \n" \
+                ">To list the possible configuration parameters, add a **/config** comment.   \n"
+       return commands_text


-def bot_help_text(user: str):
-    return f"> Tag me in a comment '@{user}' and add one of the following commands:  \n" + commands_text
+    @staticmethod
+    def get_general_bot_help_text():
+        output = f"> To invoke the PR-Agent, add a comment using one of the following commands:  \n{HelpMessage.get_general_commands_text()} \n"
+        return output
+
+    @staticmethod
+    def get_review_usage_guide():
+        output ="**Overview:**\n"
+        output +="The `review` tool scans the PR code changes, and generates a PR review. The tool can be triggered [automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on any PR.\n"
+        output +="""\
+When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L19) 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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), use the following template:
+```
+[pr_reviewer]
+some_config1=...
+some_config2=...
+```
+    """
+        output +="\n\n<table>"
+
+        # extra instructions
+        output += "<tr><td><details> <summary><strong> Utilizing extra instructions</strong></summary><hr>\n\n"
+        output += '''\
+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 'general suggestions' 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.
+        '''
+        output += "\n\n</details></td></tr>\n\n"
+
+        # automation
+        output += "<tr><td><details> <summary><strong> How to enable\\disable automation</strong></summary><hr>\n\n"
+        output += """\
+- When you first install PR-Agent app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) 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
+        """
+        output += "\n\n</details></td></tr>\n\n"
+
+#         # code feedback
+#         output += "<tr><td><details> <summary><strong> About the 'Code feedback' section</strong></summary><hr>\n\n"
+#         output+="""\
+# The `review` tool provides several type of feedbacks, one of them is code suggestions.
+# If you are interested **only** in the code suggestions, it is recommended to use the [`improve`](https://github.com/Codium-ai/pr-agent/blob/main/docs/IMPROVE.md) feature instead, since it dedicated only to code suggestions, and usually gives better results.
+# Use the `review` tool if you want to get a more comprehensive feedback, which includes code suggestions as well.
+# """
+#         output += "\n\n</details></td></tr>\n\n"
+
+        # auto-labels
+        output += "<tr><td><details> <summary><strong> Auto-labels</strong></summary><hr>\n\n"
+        output+="""\
+The `review` tool can auto-generate two specific types of labels for a PR:
+- a `possible security issue` label, that detects possible [security issues](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`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)
+"""
+        output += "\n\n</details></td></tr>\n\n"
+
+        # extra sub-tools
+        output += "<tr><td><details> <summary><strong> Extra sub-tools</strong></summary><hr>\n\n"
+        output += """\
+The `review` tool provides a collection of possible feedbacks about a PR.
+It is recommended to review the [possible options](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#enabledisable-features), 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.
+"""
+        output += "\n\n</details></td></tr>\n\n"
+
+        # general
+        output += "\n\n<tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> \n\n"
+        output += HelpMessage.get_general_bot_help_text()
+        output += "\n\n</details></td></tr>\n\n"
+
+        output += "</table>"
+
+        output += f"\n\nSee the [review usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md) page for a comprehensive guide on using this tool.\n\n"
+
+        return output


-actions_help_text = "> To invoke the PR-Agent, add a comment using one of the following commands:  \n" + \
-                    commands_text
+
+    @staticmethod
+    def get_describe_usage_guide():
+        output = "**Overview:**\n"
+        output += "The `describe` tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. "
+        output += "The tool can be triggered [automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on a PR.\n"
+        output += """\
+
+When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L46) 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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), use the following template:
+```
+[pr_description]
+some_config1=...
+some_config2=...
+```
+"""
+        output += "\n\n<table>"
+
+        # automation
+        output += "<tr><td><details> <summary><strong> Enabling\\disabling automation </strong></summary><hr>\n\n"
+        output += """\
+- When you first install the app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) 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.
+        
+"""
+        output += "\n\n</details></td></tr>\n\n"
+
+        # custom labels
+        output += "<tr><td><details> <summary><strong> Custom labels </strong></summary><hr>\n\n"
+        output += """\
+The default labels of the `describe` tool are quite generic: [`Bug fix`, `Tests`, `Enhancement`, `Documentation`, `Other`].
+
+If you specify [custom labels](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#handle-custom-labels-from-the-repos-labels-page-gem) 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.        
+"""
+        output += "\n\n</details></td></tr>\n\n"
+
+        # Inline File Walkthrough
+        output += "<tr><td><details> <summary><strong> Inline File Walkthrough 💎</strong></summary><hr>\n\n"
+        output += """\
+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.
+"""
+        # extra instructions
+        output += "<tr><td><details> <summary><strong> Utilizing extra instructions</strong></summary><hr>\n\n"
+        output += '''\
+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.
+'''
+        output += "\n\n</details></td></tr>\n\n"
+
+
+        # general
+        output += "\n\n<tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> \n\n"
+        output += HelpMessage.get_general_bot_help_text()
+        output += "\n\n</details></td></tr>\n\n"
+
+        output += "</table>"
+
+        output += f"\n\nSee the [describe usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md) page for a comprehensive guide on using this tool.\n\n"
+
+        return output
+
+    @staticmethod
+    def get_ask_usage_guide():
+        output = "**Overview:**\n"
+        output += """\
+The `ask` tool answers questions about the PR, based on the PR code changes.
+It can be invoked manually by commenting on any PR:
+```
+/ask "..."
+```
+
+Note that the tool does not have "memory" of previous questions, and answers each question independently.        
+        """
+        output += "\n\n<table>"
+
+        # general
+        output += "\n\n<tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> \n\n"
+        output += HelpMessage.get_general_bot_help_text()
+        output += "\n\n</details></td></tr>\n\n"
+
+        output += "</table>"
+
+        output += f"\n\nSee the [ask usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/ASK.md) page for a comprehensive guide on using this tool.\n\n"
+
+        return output
+
+
+    @staticmethod
+    def get_improve_usage_guide():
+        output = "**Overview:**\n"
+        output += "The `improve` tool scans the PR code changes, and automatically generates suggestions for improving the PR code. "
+        output += "The tool can be triggered [automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on a PR.\n"
+        output += """\
+When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L69) 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](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-app), use the following template:
+
+```
+[pr_code_suggestions]
+some_config1=...
+some_config2=...
+```
+    
+"""
+        output += "\n\n<table>"
+
+        # automation
+        output += "<tr><td><details> <summary><strong> Enabling\\disabling automation </strong></summary><hr>\n\n"
+        output += """\
+When you first install the app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) 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.
+"""
+        output += "\n\n</details></td></tr>\n\n"
+
+        # extra instructions
+        output += "<tr><td><details> <summary><strong> Utilizing extra instructions</strong></summary><hr>\n\n"
+        output += '''\
+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.
+    '''
+        output += "\n\n</details></td></tr>\n\n"
+
+        # suggestions quality
+        output += "\n\n<tr><td><details> <summary><strong> A note on code suggestions quality</strong></summary><hr> \n\n"
+        output += """\
+- 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 :gem:](https://github.com/Codium-ai/pr-agent/blob/main/docs/CUSTOM_SUGGESTIONS.md) tool
+- With large PRs, best quality will be obtained by using 'improve --extended' mode.
+
+
+"""
+        output += "\n\n</details></td></tr>\n\n"\
+
+        # general
+        output += "\n\n<tr><td><details> <summary><strong> More PR-Agent commands</strong></summary><hr> \n\n"
+        output += HelpMessage.get_general_bot_help_text()
+        output += "\n\n</details></td></tr>\n\n"
+
+        output += "</table>"
+
+        output += f"\n\nSee the [improve usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/IMPROVE.md) page for a more comprehensive guide on using this tool.\n\n"
+
+        return output
--- a/pr_agent/settings/configuration.toml
+++ b/pr_agent/settings/configuration.toml
@ -1,5 +1,5 @@
 [config]
-model="gpt-4" # "gpt-4-1106-preview"
+model="gpt-4" # "gpt-4-0125-preview"
 fallback_models=["gpt-3.5-turbo-16k"]
 git_provider="github"
 publish_output=true
@ -36,7 +36,7 @@ persistent_comment=true
 extra_instructions = ""
 # review labels
 enable_review_labels_security=true
-enable_review_labels_effort=false
+enable_review_labels_effort=true
 # specific configurations for incremental review (/review -i)
 require_all_thresholds_for_incremental_review=false
 minimal_commits_for_incremental_review=0
@ -46,15 +46,17 @@ enable_help_text=true # Determines whether to include help text in the PR review
 [pr_description] # /describe #
 publish_labels=true
 publish_description_as_comment=false
-add_original_user_description=false
-keep_original_user_title=false
+add_original_user_description=true
+keep_original_user_title=true
 use_bullet_points=true
 extra_instructions = ""
 enable_pr_type=true
 final_update_message = true
+enable_help_text=true
 ## changes walkthrough section
 enable_semantic_files_types=true
 collapsible_file_list='adaptive' # true, false, 'adaptive'
+inline_file_summary=false # false, true, 'table'
 # markers
 use_description_markers=false
 include_generated_by_header=true
@ -62,13 +64,15 @@ include_generated_by_header=true
 #custom_labels = ['Bug fix', 'Tests', 'Bug fix with tests', 'Enhancement', 'Documentation', 'Other']

 [pr_questions] # /ask #
+enable_help_text=true
+

 [pr_code_suggestions] # /improve #
 num_code_suggestions=4
-summarize = false
-include_improved_code = true
+summarize = true
 extra_instructions = ""
 rank_suggestions = false
+enable_help_text=true
 # params for '/improve --extended' mode
 auto_extended_mode=false
 num_code_suggestions_per_chunk=8
@ -86,6 +90,15 @@ extra_instructions = ""

 [pr_analyze] # /analyze #

+[pr_test] # /test #
+extra_instructions = ""
+testing_framework = "" # specify the testing framework you want to use
+num_tests=3            # number of tests to generate. max 5.
+avoid_mocks=true       # if true, the generated tests will prefer to use real objects instead of mocks
+file = ""              # in case there are several components with the same name, you can specify the relevant file
+class_name = ""        # in case there are several methods with the same name in the same file, you can specify the relevant class name
+enable_help_text=true
+
 [pr_config] # /config #

 [github]
@ -93,8 +106,10 @@ extra_instructions = ""
 deployment_type = "user"
 ratelimit_retries = 5
 base_url = "https://api.github.com"
+publish_inline_comments_fallback_with_verification = true
+try_fix_invalid_inline_comments = true

-[github_action]
+[github_action_config]
 # auto_review = true    # set as env var in .github/workflows/pr-agent.yaml
 # auto_describe = true  # set as env var in .github/workflows/pr-agent.yaml
 # auto_improve = true   # set as env var in .github/workflows/pr-agent.yaml
@ -111,7 +126,8 @@ duplicate_requests_cache_ttl = 60  # in seconds
 handle_pr_actions = ['opened', 'reopened', 'ready_for_review', 'review_requested']
 pr_commands = [
    "/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
-    "/review",
+    "/review --pr_reviewer.num_code_suggestions=0",
+    "/improve --pr_code_suggestions.summarize=true",
 ]
 # settings for "pull_request" event with "synchronize" action - used to detect and handle push triggers for new commits
 handle_push_trigger = false
--- a/pr_agent/settings/pr_add_docs.toml
+++ b/pr_agent/settings/pr_add_docs.toml
@ -5,7 +5,7 @@ Your task is to generate {{ docs_for_language }} for code components in the PR D

 Example for the PR Diff format:
 ======
-## src/file1.py
+## file: 'src/file1.py'

@@ -12,3 +12,4 @@ def func1():
 __new hunk__
@ -18,7 +18,6 @@ __old hunk__
 -code line that was removed in the PR
 code line2 that remained unchanged in the PR

-
@@ ... @@ def func2():
 __new hunk__
 ...
@ -26,7 +25,7 @@ __old hunk__
 ...


-## src/file2.py
+## file: 'src/file2.py'
 ...
 ======

--- a/pr_agent/settings/pr_code_suggestions_prompts.toml
+++ b/pr_agent/settings/pr_code_suggestions_prompts.toml
@ -4,19 +4,17 @@ Your task is to provide meaningful and actionable code suggestions, to improve t

 Example for the PR Diff format:
 ======
-## src/file1.py
+## file: 'src/file1.py'

-@@ -12,3 +12,4 @@ def func1():
+@@ ... @@ def func1():
 __new hunk__
 12  code line1 that remained unchanged in the PR
-14 +new code line1 added in the PR
-15 +new code line2 added in the PR
-16  code line2 that remained unchanged in the PR
+13 +new code line2 added in the PR
+14  code line3 that remained unchanged in the PR
 __old hunk__
 code line1 that remained unchanged in the PR
-code line that was removed in the PR
- code line2 that remained unchanged in the PR
-
+-old code line2 that was removed in the PR
+ code line3 that remained unchanged in the PR

@@ ... @@ def func2():
 __new hunk__
@ -25,19 +23,18 @@ __old hunk__
 ...


-## src/file2.py
+## file: 'src/file2.py'
 ...
 ======


 Specific instructions:
- Provide up to {{ num_code_suggestions }} code suggestions. Try to provide diverse and insightful suggestions.
- Prioritize suggestions that address major problems, issues and bugs in the code. As a second priority, suggestions should focus on enhancement, best practice, performance, maintainability, and other aspects.
- Don't suggest to add docstring, type hints, or comments.
- Suggestions should refer only to code from the '__new hunk__' sections, and focus on new lines of code (lines starting with '+').
+- Provide up to {{ num_code_suggestions }} code suggestions. The suggestions should be diverse and insightful.
+- The suggestions should refer only to code from the '__new hunk__' sections, and focus on new lines of code (lines starting with '+').
+- Prioritize suggestions that address major problems, issues and bugs in the PR code. As a second priority, suggestions should focus on enhancement, best practice, performance, maintainability, and other aspects.
+- Don't suggest to add docstring, type hints, or comments, or to remove unused imports.
 - Avoid making suggestions that have already been implemented in the PR code. For example, if you want to add logs, or change a variable to const, or anything else, make sure it isn't already in the '__new hunk__' code.
 - Provide the exact line numbers range (inclusive) for each suggestion.
- Assume there is additional relevant code, that is not included in the diff.
 - When quoting variables or names from the code, use backticks (`) instead of single quote (').


@ -49,15 +46,22 @@ Extra instructions from the user:
 ======
 {%- endif %}

-The output must be a YAML object equivalent to type PRCodeSuggestions, according to the following Pydantic definitions:
+The output must be a YAML object equivalent to type $PRCodeSuggestions, according to the following Pydantic definitions:
 =====
 class CodeSuggestion(BaseModel):
    relevant_file: str = Field(description="the relevant file full path")
+    language: str = Field(description="the code language of the relevant file")
    suggestion_content: str = Field(description="an actionable suggestion for meaningfully improving the new code introduced in the PR")
-    existing_code: str = Field(description="a code snippet, showing the relevant code lines from a '__new hunk__' section. It must be contiguous, correctly formatted and indented, and without line numbers")
+{%- if summarize_mode %}
+    existing_code: str = Field(description="a short code snippet from a '__new hunk__' section to illustrate the relevant existing code. Don't show the line numbers.")
+    improved_code: str = Field(description="a short code snippet to illustrate the improved code, after applying the suggestion.")
+    one_sentence_summary:str = Field(description="a short summary of the suggestion action, in a single sentence. Focus on the 'what'. Be general, and avoid method or variable names.")
+{%- else %}
+    existing_code: str = Field(description="a code snippet, demonstrating the relevant code lines from a '__new hunk__' section. It must be contiguous, correctly formatted and indented, and without line numbers")
+    improved_code: str = Field(description="a new code snippet, that can be used to replace the relevant lines in '__new hunk__' code. Replacement suggestions should be complete, correctly formatted and indented, and without line numbers")
+{%- endif %}
    relevant_lines_start: int = Field(description="The relevant line number, from a '__new hunk__' section, where the suggestion starts (inclusive). Should be derived from the hunk line numbers, and correspond to the 'existing code' snippet above")
    relevant_lines_end: int = Field(description="The relevant line number, from a '__new hunk__' section, where the suggestion ends (inclusive). Should be derived from the hunk line numbers, and correspond to the 'existing code' snippet above")
-    improved_code: str = Field(description="a new code snippet, that can be used to replace the relevant lines in '__new hunk__' code. Replacement suggestions should be complete, correctly formatted and indented, and without line numbers")
    label: str = Field(description="a single label for the suggestion, to help the user understand the suggestion type. For example: 'security', 'bug', 'performance', 'enhancement', 'possible issue', 'best practice', 'maintainability', etc. Other labels are also allowed")

 class PRCodeSuggestions(BaseModel):
@ -70,14 +74,27 @@ Example output:
 code_suggestions:
 - relevant_file: |-
    src/file1.py
+  language: |-
+    python
  suggestion_content: |-
    Add a docstring to func1()
+{%- if summarize_mode %}
+  existing_code: |-
+    def func1():
+  improved_code: |-
+    ...
+  one_sentence_summary: |-
+    ...
+  relevant_lines_start: 12
+  relevant_lines_end: 12
+{%- else %}
  existing_code: |-
    def func1():
  relevant_lines_start: 12
  relevant_lines_end: 12
  improved_code: |-
    ...
+{%- endif %}
  label: |-
    ...
 ```
@ -90,21 +107,6 @@ user="""PR Info:

 Title: '{{title}}'

-Branch: '{{branch}}'
-
-{%- if description %}
-
-Description:
-======
-{{ description|trim }}
-======
-{%- endif %}
-
-{%- if language %}
-
-Main PR language: '{{ language }}'
-{%- endif %}
-

 The PR Diff:
 ======
--- a/pr_agent/settings/pr_description_prompts.toml
+++ b/pr_agent/settings/pr_description_prompts.toml
@ -15,7 +15,7 @@ Your task is to provide a full description for the PR content - files walkthroug

 Extra instructions from the user:
 =====
-{{ extra_instructions }}
+{{extra_instructions}}
 =====
 {% endif %}

@ -39,7 +39,9 @@ class PRType(str, Enum):

 Class FileDescription(BaseModel):
    filename: str = Field(description="the relevant file full path")
-    changes_summary: str = Field(description="minimal and concise summary of the changes in the relevant file")
+    language: str = Field(description="the relevant file language")
+    changes_summary: str = Field(description="concise summary of the changes in the relevant file, in bullet points (1-4 bullet points).")
+    changes_title: str = Field(description="an informative title for the changes in the files, describing its main theme (5-10 words).")
    label: str = Field(description="a single semantic label that represents a type of code changes that occurred in the File. Possible values (partial list): 'bug fix', 'tests', 'enhancement', 'documentation', 'error handling', 'configuration changes', 'dependencies', 'formatting', 'miscellaneous', ...")
 {%- endif %}

@ -66,8 +68,12 @@ type:
 pr_files:
 - filename: |
    ...
+  language: |
+    ...
  changes_summary: |
    ...
+  changes_title: |
+    ...
  label: |
    ...
 ...
@ -101,10 +107,7 @@ Previous description:
 {%- endif %}

 Branch: '{{branch}}'
-{%- if language %}

-Main PR language: '{{ language }}'
-{%- endif %}
 {%- if commit_messages_str %}

 Commit messages:
--- a/pr_agent/settings/pr_questions_prompts.toml
+++ b/pr_agent/settings/pr_questions_prompts.toml
@ -1,7 +1,7 @@
 [pr_questions_prompt]
-system="""You are PR-Reviewer, a language model designed to review a Git Pull Request (PR).
+system="""You are PR-Reviewer, a language model designed to answer questions about a Git Pull Request (PR).

-Your goal is to answer questions\\tasks about the new PR code (lines starting with '+'), and provide feedback.
+Your goal is to answer questions\\tasks about the new code introduced in the PR (lines starting with '+' in the 'PR Git Diff' section), and provide feedback.
 Be informative, constructive, and give examples. Try to be as specific as possible.
 Don't avoid answering the questions. You must answer the questions, as best as you can, without adding any unrelated content.
 """
--- a/pr_agent/settings/pr_reviewer_prompts.toml
+++ b/pr_agent/settings/pr_reviewer_prompts.toml
@ -5,7 +5,7 @@ The review should focus on new code added in the PR diff (lines starting with '+

 Example PR Diff:
 ======
-## src/file1.py
+## file: 'src/file1.py'

@@ -12,5 +12,5 @@ def func1():
 code line 1 that remained unchanged in the PR
@ -14,12 +14,11 @@ code line 2 that remained unchanged in the PR
 +code line added in the PR
 code line 3 that remained unchanged in the PR

-
@@ ... @@ def func2():
 ...


-## src/file2.py
+## file: 'src/file2.py'
 ...
 ======

@ -115,6 +114,9 @@ PR Feedback:
      relevant file:
        type: string
        description: the relevant file full path
+      language:
+        type: string
+        description: the language of the relevant file
      suggestion:
        type: string
        description: |-
@ -166,6 +168,8 @@ PR Feedback:
  Code feedback:
    - relevant file: |-
        directory/xxx.py
+      language: |-
+        python
      suggestion: |-
        xxx [important]
      relevant line: |-
@ -195,10 +199,6 @@ Description:
 ======
 {%- endif %}

-{%- if language %}
-
-Main PR language: '{{ language }}'
-{%- endif %}
 {%- if commit_messages_str %}

 Commit messages:
--- a/pr_agent/tools/pr_code_suggestions.py
+++ b/pr_agent/tools/pr_code_suggestions.py
@ -8,12 +8,14 @@ from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
 from pr_agent.algo.ai_handlers.litellm_ai_handler import LiteLLMAIHandler
 from pr_agent.algo.pr_processing import get_pr_diff, get_pr_multi_diffs, retry_with_fallback_models
 from pr_agent.algo.token_handler import TokenHandler
-from pr_agent.algo.utils import load_yaml
+from pr_agent.algo.utils import load_yaml, replace_code_tags
 from pr_agent.config_loader import get_settings
 from pr_agent.git_providers import get_git_provider
 from pr_agent.git_providers.git_provider import get_main_pr_language
 from pr_agent.log import get_logger
-
+from pr_agent.servers.help import HelpMessage
+from pr_agent.tools.pr_description import insert_br_after_x_chars
+import difflib

 class PRCodeSuggestions:
    def __init__(self, pr_url: str, cli_mode=False, args: list = None,
@ -45,6 +47,7 @@ class PRCodeSuggestions:
            "language": self.main_language,
            "diff": "",  # empty diff for initial calculation
            "num_code_suggestions": num_code_suggestions,
+            "summarize_mode": get_settings().pr_code_suggestions.summarize,
            "extra_instructions": get_settings().pr_code_suggestions.extra_instructions,
            "commit_messages_str": self.git_provider.get_commit_messages(),
        }
@ -65,6 +68,8 @@ class PRCodeSuggestions:
                data = self._prepare_pr_code_suggestions()
            else:
                data = await retry_with_fallback_models(self._prepare_prediction_extended)
+
+
            if (not data) or (not 'code_suggestions' in data):
                get_logger().info('No code suggestions found for PR.')
                return
@ -77,9 +82,19 @@ class PRCodeSuggestions:
            if get_settings().config.publish_output:
                get_logger().info('Pushing PR code suggestions...')
                self.git_provider.remove_initial_comment()
-                if get_settings().pr_code_suggestions.summarize:
+                if get_settings().pr_code_suggestions.summarize and self.git_provider.is_supported("gfm_markdown"):
                    get_logger().info('Pushing summarize code suggestions...')
-                    self.publish_summarizes_suggestions(data)
+
+                    # generate summarized suggestions
+                    pr_body = self.generate_summarized_suggestions(data)
+
+                    # add usage guide
+                    if get_settings().pr_code_suggestions.enable_help_text:
+                        pr_body += "<hr>\n\n<details> <summary><strong>✨ Usage guide:</strong></summary><hr> \n\n"
+                        pr_body += HelpMessage.get_improve_usage_guide()
+                        pr_body += "\n</details>\n"
+
+                    self.git_provider.publish_comment(pr_body)
                else:
                    get_logger().info('Pushing inline code suggestions...')
                    self.push_inline_code_suggestions(data)
@ -154,35 +169,19 @@ class PRCodeSuggestions:
                if new_code_snippet:
                    new_code_snippet = self.dedent_code(relevant_file, relevant_lines_start, new_code_snippet)

-                if get_settings().pr_code_suggestions.include_improved_code:
-                    body = f"**Suggestion:** {content} [{label}]\n```suggestion\n" + new_code_snippet + "\n```"
-                    code_suggestions.append({'body': body, 'relevant_file': relevant_file,
+                body = f"**Suggestion:** {content} [{label}]\n```suggestion\n" + new_code_snippet + "\n```"
+                code_suggestions.append({'body': body, 'relevant_file': relevant_file,
                                             'relevant_lines_start': relevant_lines_start,
                                             'relevant_lines_end': relevant_lines_end})
-                else:
-                    if self.git_provider.is_supported("create_inline_comment"):
-                        body = f"**Suggestion:** {content} [{label}]"
-                        comment = self.git_provider.create_inline_comment(body, relevant_file, "",
-                                                                          absolute_position=relevant_lines_end)
-                        if comment:
-                            code_suggestions.append(comment)
-                    else:
-                        get_logger().error("Inline comments are not supported by the git provider")
            except Exception:
                if get_settings().config.verbosity_level >= 2:
                    get_logger().info(f"Could not parse suggestion: {d}")

-        if get_settings().pr_code_suggestions.include_improved_code:
-            is_successful = self.git_provider.publish_code_suggestions(code_suggestions)
-        else:
-            is_successful = self.git_provider.publish_inline_comments(code_suggestions)
+        is_successful = self.git_provider.publish_code_suggestions(code_suggestions)
        if not is_successful:
            get_logger().info("Failed to publish code suggestions, trying to publish each suggestion separately")
            for code_suggestion in code_suggestions:
-                if get_settings().pr_code_suggestions.include_improved_code:
-                    self.git_provider.publish_code_suggestions([code_suggestion])
-                else:
-                    self.git_provider.publish_inline_comments([code_suggestion])
+                self.git_provider.publish_code_suggestions([code_suggestion])

    def dedent_code(self, relevant_file, relevant_lines_start, new_code_snippet):
        try:  # dedent code snippet
@ -191,7 +190,8 @@ class PRCodeSuggestions:
            original_initial_line = None
            for file in self.diff_files:
                if file.filename.strip() == relevant_file:
-                    original_initial_line = file.head_file.splitlines()[relevant_lines_start - 1]
+                    if file.head_file:  # in bitbucket, head_file is empty. toDo: fix this
+                        original_initial_line = file.head_file.splitlines()[relevant_lines_start - 1]
                    break
            if original_initial_line:
                suggested_initial_line = new_code_snippet.splitlines()[0]
@ -226,7 +226,7 @@ class PRCodeSuggestions:
        for i, patches_diff in enumerate(patches_diff_list):
            get_logger().info(f"Processing chunk {i + 1} of {len(patches_diff_list)}")
            self.patches_diff = patches_diff
-            prediction = await self._get_prediction(model)
+            prediction = await self._get_prediction(model) # toDo: parallelize
            prediction_list.append(prediction)
        self.prediction_list = prediction_list

@ -253,10 +253,15 @@ class PRCodeSuggestions:
        """

        suggestion_list = []
+        if not data:
+            return suggestion_list
        for suggestion in data:
            suggestion_list.append(suggestion)
        data_sorted = [[]] * len(suggestion_list)

+        if len(suggestion_list ) == 1:
+            return suggestion_list
+
        try:
            suggestion_str = ""
            for i, suggestion in enumerate(suggestion_list):
@ -296,9 +301,13 @@ class PRCodeSuggestions:

        return data_sorted

-    def publish_summarizes_suggestions(self, data: Dict):
+    def generate_summarized_suggestions(self, data: Dict) -> str:
        try:
-            data_markdown = "## PR Code Suggestions\n\n"
+            pr_body = "## PR Code Suggestions\n\n"
+
+            if len(data.get('code_suggestions', [])) == 0:
+                pr_body += "No suggestions found to improve this PR."
+                return pr_body

            language_extension_map_org = get_settings().language_extension_map_org
            extension_to_language = {}
@ -306,30 +315,78 @@ class PRCodeSuggestions:
                for ext in extensions:
                    extension_to_language[ext] = language

-            for s in data['code_suggestions']:
-                try:
-                    extension_s = s['relevant_file'].rsplit('.')[-1]
-                    code_snippet_link = self.git_provider.get_line_link(s['relevant_file'], s['relevant_lines_start'],
-                                                                        s['relevant_lines_end'])
-                    label = s['label'].strip()
-                    data_markdown += f"\n💡 [{label}]\n\n**{s['suggestion_content'].rstrip().rstrip()}**\n\n"
-                    if code_snippet_link:
-                        data_markdown += f" File: [{s['relevant_file']} ({s['relevant_lines_start']}-{s['relevant_lines_end']})]({code_snippet_link})\n\n"
+            pr_body += "<table>"
+            header = f"Suggestions"
+            delta = 77
+            header += "&nbsp; " * delta
+            pr_body += f"""<thead><tr><th></th><th>{header}</th></tr></thead>"""
+            pr_body += """<tbody>"""
+            suggestions_labels = dict()
+            # add all suggestions related to each label
+            for suggestion in data['code_suggestions']:
+                label = suggestion['label'].strip().strip("'").strip('"')
+                if label not in suggestions_labels:
+                    suggestions_labels[label] = []
+                suggestions_labels[label].append(suggestion)
+
+            for label, suggestions in suggestions_labels.items():
+                pr_body += f"""<tr><td><strong>{label}</strong></td>"""
+                pr_body += f"""<td>"""
+                # pr_body += f"""<details><summary>{len(suggestions)} suggestions</summary>"""
+                pr_body += f"""<table>"""
+                for suggestion in suggestions:
+
+                    relevant_file = suggestion['relevant_file'].strip()
+                    relevant_lines_start = int(suggestion['relevant_lines_start'])
+                    relevant_lines_end = int(suggestion['relevant_lines_end'])
+                    range_str = ""
+                    if relevant_lines_start == relevant_lines_end:
+                        range_str = f"[{relevant_lines_start}]"
                    else:
-                        data_markdown += f"File: {s['relevant_file']} ({s['relevant_lines_start']}-{s['relevant_lines_end']})\n\n"
-                    if self.git_provider.is_supported("gfm_markdown"):
-                        data_markdown += "<details> <summary> Example code:</summary>\n\n"
-                        data_markdown += f"___\n\n"
-                    language_name = "python"
-                    if extension_s and (extension_s in extension_to_language):
-                        language_name = extension_to_language[extension_s]
-                    data_markdown += f"Existing code:\n```{language_name}\n{s['existing_code'].rstrip()}\n```\n"
-                    data_markdown += f"Improved code:\n```{language_name}\n{s['improved_code'].rstrip()}\n```\n"
-                    if self.git_provider.is_supported("gfm_markdown"):
-                        data_markdown += "</details>\n"
-                    data_markdown += "\n___\n\n"
-                except Exception as e:
-                    get_logger().error(f"Could not parse suggestion: {s}, error: {e}")
-            self.git_provider.publish_comment(data_markdown)
+                        range_str = f"[{relevant_lines_start}-{relevant_lines_end}]"
+                    code_snippet_link = self.git_provider.get_line_link(relevant_file, relevant_lines_start,
+                                                                        relevant_lines_end)
+                    # add html table for each suggestion
+
+                    suggestion_content = suggestion['suggestion_content'].rstrip().rstrip()
+
+                    suggestion_content = insert_br_after_x_chars(suggestion_content, 90)
+                    # pr_body += f"<tr><td><details><summary>{suggestion_content}</summary>"
+                    existing_code = suggestion['existing_code'].rstrip()+"\n"
+                    improved_code = suggestion['improved_code'].rstrip()+"\n"
+
+                    diff = difflib.unified_diff(existing_code.split('\n'),
+                                                improved_code.split('\n'), n=999)
+                    patch_orig = "\n".join(diff)
+                    patch = "\n".join(patch_orig.splitlines()[5:]).strip('\n')
+
+                    example_code = ""
+                    example_code += f"```diff\n{patch}\n```\n"
+
+                    pr_body += f"""<tr><td>"""
+                    suggestion_summary = suggestion['one_sentence_summary'].strip()
+                    if '`' in suggestion_summary:
+                        suggestion_summary = replace_code_tags(suggestion_summary)
+                    suggestion_summary = suggestion_summary + max((77-len(suggestion_summary)), 0)*"&nbsp;"
+                    pr_body += f"""\n\n<details><summary>{suggestion_summary}</summary>\n\n___\n\n"""
+
+                    pr_body += f"""
+  
+  
+**{suggestion_content}**
+    
+[{relevant_file} {range_str}]({code_snippet_link})
+
+{example_code}                   
+"""
+                    pr_body += f"</details>"
+                    pr_body += f"</td></tr>"
+
+                pr_body += """</table>"""
+                # pr_body += "</details>"
+                pr_body += """</td></tr>"""
+            pr_body += """</tr></tbody></table>"""
+            return pr_body
        except Exception as e:
            get_logger().info(f"Failed to publish summarized code suggestions, error: {e}")
+            return ""
--- a/pr_agent/tools/pr_description.py
+++ b/pr_agent/tools/pr_description.py
@ -14,6 +14,7 @@ from pr_agent.config_loader import get_settings
 from pr_agent.git_providers import get_git_provider
 from pr_agent.git_providers.git_provider import get_main_pr_language
 from pr_agent.log import get_logger
+from pr_agent.servers.help import HelpMessage


 class PRDescription:
@ -85,6 +86,7 @@ class PRDescription:
            if self.prediction:
                self._prepare_data()
            else:
+                self.git_provider.remove_initial_comment()
                return None

            if get_settings().pr_description.enable_semantic_files_types:
@ -98,20 +100,34 @@ class PRDescription:
                pr_title, pr_body = self._prepare_pr_answer_with_markers()
            else:
                pr_title, pr_body,  = self._prepare_pr_answer()
+
+            # Add help text if gfm_markdown is supported
+            if self.git_provider.is_supported("gfm_markdown") and get_settings().pr_description.enable_help_text:
+                pr_body += "<hr>\n\n<details> <summary><strong>✨ Usage guide:</strong></summary><hr> \n\n"
+                pr_body += HelpMessage.get_describe_usage_guide()
+                pr_body += "\n</details>\n"
+
+            # final markdown description
            full_markdown_description = f"## Title\n\n{pr_title}\n\n___\n{pr_body}"
+            get_logger().debug(f"full_markdown_description:\n{full_markdown_description}")

            if get_settings().config.publish_output:
                get_logger().info(f"Pushing answer {self.pr_id}")
+
+                # publish labels
+                if get_settings().pr_description.publish_labels and self.git_provider.is_supported("get_labels"):
+                    current_labels = self.git_provider.get_pr_labels()
+                    user_labels = get_user_labels(current_labels)
+                    self.git_provider.publish_labels(pr_labels + user_labels)
+
+                # publish description
                if get_settings().pr_description.publish_description_as_comment:
                    get_logger().info(f"Publishing answer as comment")
                    self.git_provider.publish_comment(full_markdown_description)
                else:
                    self.git_provider.publish_description(pr_title, pr_body)
-                    if get_settings().pr_description.publish_labels and self.git_provider.is_supported("get_labels"):
-                        current_labels = self.git_provider.get_pr_labels()
-                        user_labels = get_user_labels(current_labels)
-                        self.git_provider.publish_labels(pr_labels + user_labels)

+                    # publish final update message
                    if (get_settings().pr_description.final_update_message and
                            hasattr(self.git_provider, 'pr_url') and self.git_provider.pr_url):
                        latest_commit_url = self.git_provider.get_latest_commit_url()
@ -125,26 +141,17 @@ class PRDescription:
        return ""

    async def _prepare_prediction(self, model: str) -> None:
-        """
-        Prepare the AI prediction for the PR description based on the provided model.
-
-        Args:
-            model (str): The name of the model to be used for generating the prediction.
-
-        Returns:
-            None
-
-        Raises:
-            Any exceptions raised by the 'get_pr_diff' and '_get_prediction' functions.
-
-        """
        if get_settings().pr_description.use_description_markers and 'pr_agent:' not in self.user_description:
            return None

        get_logger().info(f"Getting PR diff {self.pr_id}")
        self.patches_diff = get_pr_diff(self.git_provider, self.token_handler, model)
-        get_logger().info(f"Getting AI prediction {self.pr_id}")
-        self.prediction = await self._get_prediction(model)
+        if self.patches_diff:
+            get_logger().info(f"Getting AI prediction {self.pr_id}")
+            self.prediction = await self._get_prediction(model)
+        else:
+            get_logger().error(f"Error getting PR diff {self.pr_id}")
+            self.prediction = None

    async def _get_prediction(self, model: str) -> str:
        """
@ -279,7 +286,7 @@ class PRDescription:
        if not get_settings().pr_description.enable_pr_type:
            self.data.pop('type')
        for key, value in self.data.items():
-            markdown_text += f"## {key}\n\n"
+            markdown_text += f"## **{key}**\n\n"
            markdown_text += f"{value}\n\n"

        # Remove the 'PR Title' key from the dictionary
@ -300,7 +307,7 @@ class PRDescription:
                key_publish = "Changes walkthrough"
            else:
                key_publish = key.rstrip(':').replace("_", " ").capitalize()
-            pr_body += f"## {key_publish}\n"
+            pr_body += f"## **{key_publish}**\n"
            if 'walkthrough' in key.lower():
                if self.git_provider.is_supported("gfm_markdown"):
                    pr_body += "<details> <summary>files:</summary>\n\n"
@ -331,10 +338,11 @@ class PRDescription:
            try:
                filename = file['filename'].replace("'", "`").replace('"', '`')
                changes_summary = file['changes_summary']
+                changes_title = file['changes_title'].strip()
                label = file.get('label')
                if label not in self.file_label_dict:
                    self.file_label_dict[label] = []
-                self.file_label_dict[label].append((filename, changes_summary))
+                self.file_label_dict[label].append((filename, changes_title, changes_summary))
            except Exception as e:
                get_logger().error(f"Error preparing file label dict {self.pr_id}: {e}")
                pass
@ -355,9 +363,9 @@ class PRDescription:
        try:
            pr_body += "<table>"
            header = f"Relevant files"
-            delta = 65
-            header += "&nbsp; " * delta
-            pr_body += f"""<thead><tr><th></th><th>{header}</th></tr></thead>"""
+            delta = 77
+            # header += "&nbsp; " * delta
+            pr_body += f"""<thead><tr><th></th><th align="left">{header}</th></tr></thead>"""
            pr_body += """<tbody>"""
            for semantic_label in value.keys():
                s_label = semantic_label.strip("'").strip('"')
@ -368,19 +376,24 @@ class PRDescription:
                    pr_body += f"""<td><details><summary>{len(list_tuples)} files</summary><table>"""
                else:
                    pr_body += f"""<td><table>"""
-                for filename, file_change_description in list_tuples:
+                for filename, file_changes_title, file_change_description in list_tuples:
                    filename = filename.replace("'", "`")
                    filename_publish = filename.split("/")[-1]
-                    filename_publish = f"{filename_publish}"
-                    if len(filename_publish) < (delta - 5):
-                        filename_publish += "&nbsp; " * ((delta - 5) - len(filename_publish))
+                    file_changes_title_br = insert_br_after_x_chars(file_changes_title, x=(delta - 5),
+                                                                    new_line_char="\n\n")
+                    file_changes_title_extended = file_changes_title_br.strip() + "</code>"
+                    if len(file_changes_title_extended) < (delta - 5):
+                        file_changes_title_extended += "&nbsp; " * ((delta - 5) - len(file_changes_title_extended))
+                    filename_publish = f"<strong>{filename_publish}</strong><dd><code>{file_changes_title_extended}</dd>"
                    diff_plus_minus = ""
+                    delta_nbsp = ""
                    diff_files = self.git_provider.diff_files
                    for f in diff_files:
                        if f.filename.lower() == filename.lower():
                            num_plus_lines = f.num_plus_lines
                            num_minus_lines = f.num_minus_lines
                            diff_plus_minus += f"+{num_plus_lines}/-{num_minus_lines}"
+                            delta_nbsp = "&nbsp; " * max(0, (8 - len(diff_plus_minus)))
                            break

                    # try to add line numbers link to code suggestions
@ -389,21 +402,19 @@ class PRDescription:
                        filename = filename.strip()
                        link = self.git_provider.get_line_link(filename, relevant_line_start=-1)

-                    file_change_description = self._insert_br_after_x_chars(file_change_description, x=(delta - 5))
+                    file_change_description_br = insert_br_after_x_chars(file_change_description, x=(delta - 5))
                    pr_body += f"""
 <tr>
  <td>
    <details>
-      <summary><strong>{filename_publish}</strong></summary>
-      <ul>
-        {filename}<br><br>
+      <summary>{filename_publish}</summary>
+<hr>

-**{file_change_description}**
-</ul>
+{filename}
+{file_change_description_br}
    </details>
  </td>
-  <td><a href="{link}"> {diff_plus_minus}</a></td>
-
+  <td><a href="{link}">{diff_plus_minus}</a>{delta_nbsp}</td>
 </tr>                    
 """
                if use_collapsible_file_list:
@ -417,25 +428,48 @@ class PRDescription:
            pass
        return pr_body

-    def _insert_br_after_x_chars(self, text, x=70):
-        """
-        Insert <br> into a string after a word that increases its length above x characters.
-        """
-        if len(text) < x:
-            return text
+def insert_br_after_x_chars(text, x=70, new_line_char="<br> "):
+    """
+    Insert <br> into a string after a word that increases its length above x characters.
+    """
+    if len(text) < x:
+        return text

-        words = text.split(' ')
-        new_text = ""
-        current_length = 0
+    lines = text.splitlines()
+    words = []
+    for i,line in enumerate(lines):
+        words += line.split(' ')
+        if i<len(lines)-1:
+            words[-1] += "\n"

-        for word in words:
-            # Check if adding this word exceeds x characters
-            if current_length + len(word) > x:
-                new_text += "<br>"  # Insert line break
+
+    # words = text.split(' ')
+
+    new_text = ""
+    current_length = 0
+    is_inside_code = False
+    for word in words:
+        # Check if adding this word exceeds x characters
+        if current_length + len(word) > x:
+            if not is_inside_code:
+                new_text += f"{new_line_char} "  # Insert line break
                current_length = 0  # Reset counter
+            else:
+                new_text += f"`{new_line_char} `"
+        # check if inside <code> tag
+        if word.startswith("`") and not is_inside_code and not word.endswith("`"):
+            is_inside_code = True
+        if word.endswith("`"):
+            is_inside_code = False

-            # Add the word to the new text
+        # Add the word to the new text
+        if word.endswith("\n"):
+            new_text += word
+        else:
            new_text += word + " "
-            current_length += len(word) + 1  # Add 1 for the space
+        current_length += len(word) + 1  # Add 1 for the space

-        return new_text.strip()  # Remove trailing space
+
+        if word.endswith("\n"):
+            current_length = 0
+    return new_text.strip()  # Remove trailing space
--- a/pr_agent/tools/pr_questions.py
+++ b/pr_agent/tools/pr_questions.py
@ -11,6 +11,7 @@ from pr_agent.config_loader import get_settings
 from pr_agent.git_providers import get_git_provider
 from pr_agent.git_providers.git_provider import get_main_pr_language
 from pr_agent.log import get_logger
+from pr_agent.servers.help import HelpMessage


 class PRQuestions:
@ -52,6 +53,11 @@ class PRQuestions:
        await retry_with_fallback_models(self._prepare_prediction)
        get_logger().info('Preparing answer...')
        pr_comment = self._prepare_pr_answer()
+        if self.git_provider.is_supported("gfm_markdown") and get_settings().pr_questions.enable_help_text:
+            pr_comment += "<hr>\n\n<details> <summary><strong>✨ Usage guide:</strong></summary><hr> \n\n"
+            pr_comment += HelpMessage.get_ask_usage_guide()
+            pr_comment += "\n</details>\n"
+
        if get_settings().config.publish_output:
            get_logger().info('Pushing answer...')
            self.git_provider.publish_comment(pr_comment)
--- a/pr_agent/tools/pr_reviewer.py
+++ b/pr_agent/tools/pr_reviewer.py
@ -17,7 +17,7 @@ from pr_agent.config_loader import get_settings
 from pr_agent.git_providers import get_git_provider
 from pr_agent.git_providers.git_provider import IncrementalPR, get_main_pr_language
 from pr_agent.log import get_logger
-from pr_agent.servers.help import actions_help_text, bot_help_text
+from pr_agent.servers.help import HelpMessage


 class PRReviewer:
@ -98,14 +98,7 @@ class PRReviewer:
        self.incremental = IncrementalPR(is_incremental)

    async def run(self) -> None:
-        """
-        Review the pull request and generate feedback.
-        """
-
        try:
-            # if self.is_auto and not get_settings().pr_reviewer.automatic_review:
-            #     get_logger().info(f'Automatic review is disabled {self.pr_url}')
-            #     return None
            if self.incremental.is_incremental and not self._can_run_incremental_review():
                return None

@ -115,6 +108,9 @@ class PRReviewer:
                self.git_provider.publish_comment("Preparing review...", is_temporary=True)

            await retry_with_fallback_models(self._prepare_prediction)
+            if not self.prediction:
+                self.git_provider.remove_initial_comment()
+                return None

            get_logger().info('Preparing PR review...')
            pr_comment = self._prepare_pr_review()
@ -141,19 +137,14 @@ class PRReviewer:
            get_logger().error(f"Failed to review PR: {e}")

    async def _prepare_prediction(self, model: str) -> None:
-        """
-        Prepare the AI prediction for the pull request review.
-
-        Args:
-            model: A string representing the AI model to be used for the prediction.
-
-        Returns:
-            None
-        """
        get_logger().info('Getting PR diff...')
        self.patches_diff = get_pr_diff(self.git_provider, self.token_handler, model)
-        get_logger().info('Getting AI prediction...')
-        self.prediction = await self._get_prediction(model)
+        if self.patches_diff:
+            get_logger().info('Getting AI prediction...')
+            self.prediction = await self._get_prediction(model)
+        else:
+            get_logger().error(f"Error getting PR diff")
+            self.prediction = None

    async def _get_prediction(self, model: str) -> str:
        """
@ -249,16 +240,11 @@ class PRReviewer:
            data.move_to_end('Incremental PR Review', last=False)

        markdown_text = convert_to_markdown(data, self.git_provider.is_supported("gfm_markdown"))
-        user = self.git_provider.get_user_id()

        # Add help text if gfm_markdown is supported
        if self.git_provider.is_supported("gfm_markdown") and get_settings().pr_reviewer.enable_help_text:
-            markdown_text += "\n\n<details> <summary><strong>✨ Usage tips:</strong></summary><hr> \n\n"
-            bot_user = "[bot]" if get_settings().github_app.override_deployment_type else get_settings().github_app.bot_user
-            if user and bot_user not in user and not get_settings().get("CONFIG.CLI_MODE", False):
-                markdown_text += bot_help_text(user)
-            else:
-                markdown_text += actions_help_text
+            markdown_text += "<hr>\n\n<details> <summary><strong>✨ Usage guide:</strong></summary><hr> \n\n"
+            markdown_text += HelpMessage.get_review_usage_guide()
            markdown_text += "\n</details>\n"

        # Add custom labels from the review prediction (effort, security)
--- a/pr_agent/tools/pr_similar_issue.py
+++ b/pr_agent/tools/pr_similar_issue.py
@ -5,7 +5,6 @@ from typing import List
 import openai
 import pandas as pd
 import pinecone
-import lancedb
 from pinecone_datasets import Dataset, DatasetMetadata
 from pydantic import BaseModel, Field

@ -108,6 +107,7 @@ class PRSimilarIssue:
                    get_logger().info('No new issues to update')
        
        elif get_settings().pr_similar_issue.vectordb == "lancedb":
+            import lancedb # import lancedb only if needed
            self.db = lancedb.connect(get_settings().lancedb.uri)
            self.table = None

--- a/requirements.txt
+++ b/requirements.txt
@ -1,5 +1,5 @@
 aiohttp==3.9.1
-atlassian-python-api==3.39.0
+atlassian-python-api==3.41.4
 azure-devops==7.1.0b3
 boto3==1.33.6
 dynaconf==3.2.4
Author	SHA1	Message	Date
Tal	7168326911	Update TOOLS_GUIDE.md	2024-01-30 08:22:29 +02:00
Tal	e1ae51e7a0	Update TOOLS_GUIDE.md	2024-01-30 08:21:43 +02:00
Tal	c69962479a	Merge pull request #630 from Codium-ai/tr/language Enhancements in Patch Formatting and Code Suggestions Handling	2024-01-29 12:11:23 -08:00
mrT23	15c8fe94bb	feat: Improve patch formatting and handle empty data in pr_code_suggestions.py	2024-01-29 22:00:11 +02:00
mrT23	0d86779799	feat: Improve patch formatting and handle empty data in pr_code_suggestions.py	2024-01-29 21:52:54 +02:00
mrT23	6565556e01	feat: Add 'language' field to CodeSuggestion, FileDescription, and ReviewerPrompt models in settings files	2024-01-29 20:51:24 +02:00
Tal	6998089549	Update README.md	2024-01-29 20:21:23 +02:00
mrT23	8d36e2e2f7	feat: Add new configuration options in pr_test section and update TEST.md documentation	2024-01-29 20:17:39 +02:00
Tal	93f1854c68	Merge pull request #629 from Codium-ai/tr/tests s	2024-01-29 01:43:46 -08:00
mrT23	40a7ef9132	s	2024-01-29 11:42:32 +02:00
mrT23	042eab1641	s	2024-01-29 11:39:50 +02:00
mrT23	567b400f97	Revert "s1" This reverts commit `412159bba5`.	2024-01-29 11:30:58 +02:00
mrT23	412159bba5	s1	2024-01-29 11:28:58 +02:00
Tal	e6f548920b	Merge branch 'main' into tr/tests	2024-01-29 01:23:27 -08:00
mrT23	f1fe2563f4	s	2024-01-29 11:22:46 +02:00
mrT23	467e2ae68e	s	2024-01-29 11:19:37 +02:00
mrT23	78bb54bd8f	s	2024-01-29 11:11:30 +02:00
Tal	2bebfba4b6	Update README.md	2024-01-28 20:39:45 +02:00
Tal	815073e04f	Merge pull request #628 from Codium-ai/tr/tests tests readme	2024-01-28 10:32:27 -08:00
mrT23	5f1722ed4a	s	2024-01-28 20:30:40 +02:00
mrT23	47af04d158	s	2024-01-28 20:26:58 +02:00
Tal	335654b02a	Update Usage.md	2024-01-27 21:38:25 +02:00
Tal	68e17ed2be	Merge pull request #627 from Codium-ai/tr/updates2 Tr/updates2	2024-01-27 11:33:33 -08:00
mrT23	ecb46435b3	s	2024-01-27 21:29:19 +02:00
mrT23	98ce0a7036	s	2024-01-27 21:25:43 +02:00
mrT23	76f44b13f8	docs: Update GitHub app configurations section in Usage.md	2024-01-27 21:20:10 +02:00
mrT23	06dede29f2	feat: Update configuration and handling of GitHub Action settings	2024-01-27 21:15:23 +02:00
Tal	dbf5ebcb8d	Merge pull request #622 from eltociear/fix-filename docs: fix file name	2024-01-25 02:09:27 -08:00
Tal	d6a45663f1	Merge pull request #624 from Codium-ai/hl/small_fixes small fixes	2024-01-25 02:09:04 -08:00
Hussam.lawen	07eaa59e78	small fixes	2024-01-25 11:07:43 +02:00
Ikko Eltociear Ashimine	1e2d4e9830	docs: fix file name	2024-01-25 15:03:58 +09:00
Tal	cc03f7f615	Merge pull request #620 from Codium-ai/tr/updates Configuration updates	2024-01-24 09:59:43 -08:00
Tal	040da2fbb1	Merge pull request #612 from Codium-ai/mrT23-patch-1 Update README.md	2024-01-24 09:59:25 -08:00
Tal	a83a492b22	Merge branch 'main' into mrT23-patch-1	2024-01-24 09:58:23 -08:00
mrT23	e056cd5988	type	2024-01-24 19:55:33 +02:00
mrT23	4077c5556d	enable_review_labels_effort set to true by default	2024-01-24 19:49:43 +02:00
mrT23	d8465ea9f9	removed include_improved_code	2024-01-24 19:47:30 +02:00
mrT23	f4037e0dfa	feat: Add LanceDB support for similar_issue tool and refactor SOC2 compliance feature name	2024-01-24 19:40:58 +02:00
Hussam Lawen	9986f5307c	Merge pull request #618 from Codium-ai/hl/describe_usage_guide Enhance Documentation for "Inline File Walkthrough" Feature	2024-01-24 10:15:21 +02:00
Hussam.lawen	60c0371854	highlight options	2024-01-23 18:13:08 +02:00
Hussam.lawen	139bbfc67a	update docs and usage guide	2024-01-23 17:58:55 +02:00
Ori Kotek	b33b8c12cd	Merge pull request #616 from Codium-ai/hl/walkthrough_title_ui_improvements update default config for inline_file_summary to false	2024-01-22 10:37:02 +02:00
Hussam.lawen	968684b461	update default config for inline_file_summary to false	2024-01-22 10:25:34 +02:00
Tal	4a5cff4995	Update CUSTOM_SUGGESTIONS.md	2024-01-21 17:58:01 +02:00
Hussam Lawen	599c6773f3	Merge pull request #613 from Codium-ai/hl/walkthrough_title_ui_improvements Add changes title of files and improve table style and alignments	2024-01-21 17:52:44 +02:00
Tal	7178ddac10	Update CUSTOM_SUGGESTIONS.md	2024-01-21 17:31:33 +02:00
Tal	5dedc381a6	Merge pull request #615 from Codium-ai/mrT23-patch-2 Update README.md	2024-01-21 07:30:14 -08:00
Tal	cba14ada2c	Update README.md	2024-01-21 17:29:29 +02:00
Tal	f81fe0a12d	Merge pull request #614 from Codium-ai/tr/custom_suggestions feat: Add custom suggestions tool to README.md	2024-01-21 07:19:22 -08:00
mrT23	78d886459a	feat: Add custom suggestions tool to README.md	2024-01-21 17:15:34 +02:00
mrT23	27aafb06cb	feat: Add custom suggestions tool to README.md	2024-01-21 17:10:23 +02:00
mrT23	329f7fa9d6	feat: Add custom suggestions tool to README.md	2024-01-21 17:06:25 +02:00
Hussam.lawen	e79919b5c6	update describe screenshot to the new describe	2024-01-21 14:09:17 +02:00
Hussam.lawen	8d513e078a	Add changes title of files and improve table style and alignments	2024-01-21 13:43:37 +02:00
Tal	69f7923552	Update README.md	2024-01-20 13:02:07 +02:00
Tal	2430a1a608	Merge pull request #594 from Codium-ai/tr/fallback_bad_review_comment Enhanced Comment Verification and Fallback Mechanism for Inline Comment Publishing	2024-01-20 02:04:06 -08:00
mrT23	e54388d807	s	2024-01-20 11:59:45 +02:00
mrT23	d942bdb8bd	s	2024-01-20 11:56:17 +02:00
Tal	84d87aa870	Merge pull request #607 from Codium-ai/tr/edge_cases feat: Improve error handling and code readability in pr_agent tools	2024-01-18 07:09:07 -08:00
mrT23	39891e4ab1	feat: Improve error handling and code readability in pr_agent tools	2024-01-18 17:01:25 +02:00
Sagi Medina	d7858efbbe	Merge pull request #581 from Codium-ai/sm/azure_devops Enhancement of AzureDevopsProvider with new functionalities and refactoring	2024-01-18 16:28:28 +02:00
Tal	b3365b8d6c	Merge pull request #605 from Codium-ai/tr/edge_cases No suggestions found	2024-01-18 06:18:43 -08:00
mrT23	fc5b00f4d3	s	2024-01-18 16:11:44 +02:00
Tal	5150e66723	Merge pull request #603 from Codium-ai/mrT23-patch-1 Update README.md	2024-01-17 22:21:44 -08:00
Tal	4dad1af77b	Update README.md	2024-01-18 08:20:09 +02:00
Tal	02129b40cf	Merge pull request #601 from Codium-ai/hl/diffview_file_summary Readme Inline file summary 💎	2024-01-17 06:37:53 -08:00
Hussam.lawen	3fb6d17338	width	2024-01-17 16:36:26 +02:00
Hussam.lawen	3be7bfce79	feat: Add repository labels retrieval function in gitlab_provider.py docs: Update links and add Inline file summary to TOC in DESCRIBE.md	2024-01-17 16:33:48 +02:00
Hussam.lawen	472646ddfd	Readme	2024-01-17 16:27:07 +02:00
Hussam Lawen	eb4a1c515e	Merge pull request #600 from Codium-ai/tr/improve_usage_guide readme updates	2024-01-17 15:55:42 +02:00
mrT23	e4af0b22ad	s	2024-01-17 15:51:42 +02:00
mrT23	a3e59a418e	Merge remote-tracking branch 'origin/main' into tr/improve_usage_guide	2024-01-17 15:46:05 +02:00
mrT23	4e833c0c28	s	2024-01-17 15:43:01 +02:00
Tal	0b811d97a7	Merge pull request #598 from Codium-ai/tr/improve_usage_guide Enhancements to the 'improve' tool and updates to the related documentation	2024-01-17 03:13:33 -08:00
mrT23	8f510dc553	s	2024-01-17 11:47:59 +02:00
mrT23	2132771f46	s	2024-01-17 11:29:50 +02:00
mrT23	e66bd7caa7	fallback to commitable	2024-01-17 11:18:30 +02:00
mrT23	17ce2f0ed0	improve usage guide	2024-01-17 10:09:44 +02:00
mrT23	7298548f82	improve usage guide	2024-01-17 10:06:27 +02:00
mrT23	298c41a100	improve usage guide	2024-01-17 10:03:48 +02:00
mrT23	58163e5129	improve usage guide	2024-01-17 09:50:48 +02:00
Tal	fae3bf6309	Merge pull request #590 from EduardDurech/patch-2 Fixed Run from source instructions for Python	2024-01-16 22:53:36 -08:00
Hussam Lawen	06f0235577	Merge pull request #597 from Codium-ai/hl/improve_ui_table Hl/improve UI table	2024-01-16 09:46:34 +02:00
Hussam.lawen	d7e0aad527	small fixes	2024-01-16 09:41:31 +02:00
Hussam.lawen	31576b77ff	improve backticks	2024-01-15 19:07:41 +02:00
Hussam.lawen	ea39e8684f	works	2024-01-15 16:42:50 +02:00
Hussam.lawen	afefc15b9c	improve doce suggestions UI with difflib	2024-01-15 15:56:48 +02:00
Hussam.lawen	5e17ccaf86	add colaplsable	2024-01-15 15:17:57 +02:00
Hussam.lawen	9b1eb86d75	first iteration of improved UI for /improve --extended	2024-01-15 15:10:54 +02:00
mrT23	9f5c2e5f17	feat: Refactor comment verification in github_provider.py	2024-01-14 11:55:07 +02:00
mrT23	7377f4e4b2	feat: Refactor comment verification in github_provider.py	2024-01-14 11:49:51 +02:00
mrT23	d6f4c1638d	feat: Refactor comment verification in github_provider.py	2024-01-14 10:49:05 +02:00
EduardDurech	a58c385b0f	Fixed Rust warning tip as behaviour is inconsistent	2024-01-14 04:16:32 +01:00
EduardDurech	7a3830d228	Fixed Run from source instructions for Python Previously only installed dependencies but not pr_agent + Fixed link to OpenAI API Key and added for GitHub access token	2024-01-13 06:29:07 +01:00
Tal	e7251ada3f	Merge pull request #588 from barnett-yuxiang/ignore-ds-store Ignore .DS_Store files	2024-01-10 07:25:49 -08:00
Kamakura.Yx	aca3fcb571	Ignore .DS_Store files This commit updates the .gitignore file to ignore .DS_Store files, which are created by macOS. These files are not relevant to the project and should not be included in version control. Signed-off-by: Kamakura.Yx <barnett.yuxiang@gmail.com>	2024-01-10 23:13:57 +08:00
zmeir	b9951fce62	Typo when parsing the suggestion part	2024-01-10 11:59:45 +02:00
Tal	609836bd6a	Merge pull request #587 from Codium-ai/tr/abbrevations Enhancement: Improve PR-Agent Tool with Custom Labels, Extra Instructions, and Summarize Mode	2024-01-09 23:39:04 -08:00
mrT23	09ee0b64ba	feat: Refactor instructions and fields in pr_code_suggestions_prompts.toml	2024-01-10 09:37:05 +02:00
Tal	fb4746fd09	Merge pull request #584 from samanhappy/link Fix link formatting for relevant_line	2024-01-09 23:22:55 -08:00
mrT23	729b5d11c9	feat: Refactor instructions and fields in pr_code_suggestions_prompts.toml	2024-01-09 22:56:25 +02:00
mrT23	fc502a6fd5	feat: Refactor instructions and fields in pr_code_suggestions_prompts.toml	2024-01-09 22:49:26 +02:00
mrT23	2b607dbd9a	feat: Refactor instructions and fields in pr_code_suggestions_prompts.toml	2024-01-09 22:32:09 +02:00
mrT23	9c6aabb0bb	feat: Add custom labels and extra instructions sections to help.py, summarize mode to pr_code_suggestions.py, and summarize mode condition to pr_code_suggestions_prompts.toml	2024-01-09 22:09:48 +02:00
Tal	da3ac656ee	Merge pull request #586 from Codium-ai/tr/ask_usage ask helper	2024-01-09 06:55:30 -08:00
mrT23	a42e57d09b	ask helper	2024-01-09 16:36:39 +02:00
mrT23	e56c443fd6	ask helper	2024-01-09 16:34:27 +02:00
mrT23	abc05e7711	ask helper	2024-01-09 16:25:23 +02:00
Tal	a77d539866	Merge pull request #585 from samanhappy/url Enhancement: Update GitLab link generation to support self-managed GitLab server and different projects	2024-01-09 06:12:05 -08:00
zmeir	19c14b940e	Try fixing invalid inline comments	2024-01-09 09:54:29 +02:00
samanhappy	36f1cfb51f	Enhancement: Update GitLab link generation to support self-managed GitLab server and different projects	2024-01-09 15:11:27 +08:00
samanhappy	0f2a4654a7	Fix link formatting for relevant_line	2024-01-09 14:56:18 +08:00
zmeir	28c5ad1d8b	nit	2024-01-08 13:06:03 +02:00
zmeir	2bb5ae8c0d	Remove redundant condition (status 422 already means the same)	2024-01-08 13:05:10 +02:00
zmeir	b0bffdec84	Refactor and add configuration toggle	2024-01-08 12:00:20 +02:00
Tal	11b96b1c1a	Merge pull request #583 from Codium-ai/tr/unique_titles feat: Remove bot help text from github_polling.py	2024-01-08 01:51:43 -08:00
mrT23	e0f4bc7ded	feat: Remove bot help text from github_polling.py	2024-01-08 11:45:01 +02:00
Tal	62d83f6753	Merge pull request #582 from Codium-ai/tr/unique_titles Enhance PR description headers with bold formatting and include original user description	2024-01-08 01:28:56 -08:00
mrT23	e9a2a0a96f	s	2024-01-08 10:37:51 +02:00
mrT23	46a38473e4	Merge remote-tracking branch 'origin/main' into tr/unique_titles	2024-01-08 10:30:58 +02:00
mrT23	c9e55be275	s	2024-01-08 10:30:47 +02:00
Tal	f714592dec	Merge pull request #579 from Codium-ai/tr/user_description Enhancements to Logging, Help Messages, and PR Descriptions and Reviews	2024-01-07 23:46:25 -08:00
mrT23	8bb2eb48af	s	2024-01-08 09:43:34 +02:00
mrT23	9cfb8ce475	s	2024-01-08 09:39:19 +02:00
mrT23	67cb133c52	s	2024-01-08 09:28:44 +02:00
mrT23	9c054bb80f	s	2024-01-08 09:18:46 +02:00
Sagi Medina	b776e5069c	feat: Refactor AzureDevopsProvider class in azuredevops_provider.py - Reorder class methods and constructor for better readability - Add error logging for failed operations - Implement get_pr_description_full method - Update get_pr_description method to always return full description - Modify _parse_pr_url method to return workspace_slug, repo_slug, and pr_number - Make _get_azure_devops_client a static method - Add error handling in get_pr_id method	2024-01-08 09:15:34 +02:00
Sagi Medina	c8bca487e5	feat: Implement methods in AzureDevopsProvider for publishing code suggestions, labels, and removing comments	2024-01-08 08:59:12 +02:00
Tal	78fa61eac6	Merge branch 'main' into tr/user_description	2024-01-07 22:55:18 -08:00
Tal	582cbd623f	Merge pull request #580 from Codium-ai/tr/add_logs feat: Add debug logs to git_provider and pr_description modules	2024-01-07 09:58:20 -08:00
mrT23	3ea08a6cf5	feat: Add debug logs to git_provider and pr_description modules	2024-01-07 19:57:49 +02:00
mrT23	3154ebbf9f	feat: Add debug logs to git_provider and pr_description modules	2024-01-07 19:56:05 +02:00
Tal	8fe608884d	Merge pull request #578 from Codium-ai/ok/atlassian_version feat: Update atlassian-python-api version in requirements.txt	2024-01-07 09:17:56 -08:00
Ori Kotek	60e79f0134	feat: Update atlassian-python-api version in requirements.txt	2024-01-07 18:08:11 +02:00
mrT23	a6bbd04efb	s	2024-01-07 17:02:18 +02:00
mrT23	578d15c6fc	usage guide	2024-01-07 16:38:08 +02:00
zmeir	22d17985a1	Less noisy fallback for `publish_code_suggestions` in case of invalid comments As a first option, `publish_code_suggestions` will try to post all review comments in a single GitHub review. This is preferred because it will group all comments together in the GitHub UI under the same review, and will trigger just one notification for any viewers of the PR. If just one of the comments is malformed, the entire API request will fail and none of the comments will be posted to the PR. In the current implementation, the fallback mechanism is to just post each comment separately with `try/except` and skip the invalid comments. This works, but potentially creates a lot of noise in the PR as each comment is posted as in a separate review, creating multiple notifications. This suggested fallback is based on a similar idea, but without creating multiple review notifications. The it works is by iterating over the potential comments, and starting a PENDING review for the current comment. The review is not submitted and does not trigger a notification, but it is verified against the GitHub API, and so we can verify if the comment is valid. After checking all comments we then submit a single review with all the verified comments which is guaranteed to succeed. The end result is having the exact same comments posted to the PR as with the current fallback method, but the downside is having twice as many API calls (for each comment we have 1 extra API call to delete the pending review).	2024-01-07 16:00:44 +02:00