mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-07-10 07:40:39 +08:00
Refactor markdown image syntax and enhance documentation presentation
This commit is contained in:
Almog Lavi
@ -11,13 +11,11 @@ It can be invoked manually by commenting on any PR:
|
||||
## Example usage
|
||||
An example [result](https://github.com/Codium-ai/pr-agent/pull/546#issuecomment-1868524805):
|
||||
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/analyze_1.png width="768"></kbd>
|
||||
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/analyze_2.png width="768"></kbd>
|
||||
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/analyze_3.png width="768"></kbd>
|
||||
|
||||
|
||||
{width=750}
|
||||
→
|
||||
{width=750}
|
||||
→
|
||||
{width=750}
|
||||
|
||||
**Notes**
|
||||
|
||||
|
||||
@ -7,9 +7,9 @@ It can be invoked manually by commenting on any PR:
|
||||
```
|
||||
For example:
|
||||
|
||||
<kbd><img src="https://codium.ai/images/pr_agent/ask_comment.png" width="768"></kbd>
|
||||
{width=768}
|
||||
|
||||
<kbd><img src="https://codium.ai/images/pr_agent/ask.png" width="768"></kbd>
|
||||
{width=768}
|
||||
|
||||
## Ask lines
|
||||
|
||||
@ -18,6 +18,6 @@ You can run `/ask` on specific lines of code in the PR from the PR's diff view.
|
||||
- To select multiple lines, click on the '+' sign of the first line and then hold and drag to select the rest of the lines.
|
||||
- write `/ask "..."` in the comment box and press `Add single comment` button.
|
||||
|
||||
<kbd><img src="https://codium.ai/images/pr_agent/Ask_line.png" width="768"></kbd>
|
||||
{width=768}
|
||||
|
||||
Note that the tool does not have "memory" of previous questions, and answers each question independently.
|
||||
|
||||
@ -8,13 +8,10 @@ The tool analyzes the failed checks and provides several feedbacks:
|
||||
- Failure summary
|
||||
- Relevant error logs
|
||||
|
||||
<kbd>
|
||||
<img src="https://www.codium.ai/images/pr_agent/failed_check1.png" width="768">
|
||||
</kbd>
|
||||
{width=768}
|
||||
|
||||
→
|
||||
<kbd>
|
||||
<img src="https://www.codium.ai/images/pr_agent/failed_check2.png" width="768">
|
||||
</kbd>
|
||||
{width=768}
|
||||
|
||||
___
|
||||
|
||||
|
||||
@ -9,11 +9,11 @@ For example:
|
||||
|
||||
If we wish to add detect changes to SQL queries in a given PR, we can add the following custom label along with its description:
|
||||
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/custom_labels_list.png width="768"></kbd>
|
||||
{width=768}
|
||||
|
||||
When running the `generate_labels` tool on a PR that includes changes in SQL queries, it will automatically suggest the custom label:
|
||||
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/custom_label_published.png width="768"></kbd>
|
||||
{width=768}
|
||||
|
||||
Note that in addition to the dedicated tool `generate_labels`, the custom labels will also be used by the `describe` tool.
|
||||
|
||||
@ -36,7 +36,8 @@ b. Add/edit the custom labels. It should be formatted as follows:
|
||||
* Label name: The name of the custom label.
|
||||
* Description: Start the description of with prefix `pr_agent:`, for example: `pr_agent: Description of when AI should suggest this label`.<br>
|
||||
The description should be comprehensive and detailed, indicating when to add the desired label.
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/add_native_custom_labels.png width="880"></kbd>
|
||||
|
||||
{width=880}
|
||||
|
||||
c. Now the custom labels will be included in the `generate_labels` tool.
|
||||
|
||||
|
||||
@ -43,10 +43,9 @@ The instructions above are just an example. We want to emphasize that the prompt
|
||||
|
||||
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>
|
||||
|
||||
{width=512}
|
||||
→
|
||||
{width=768}
|
||||
|
||||
## Configuration options
|
||||
|
||||
|
||||
@ -7,17 +7,9 @@ The tool can be triggered automatically every time a new PR is [opened](../usage
|
||||
```
|
||||
For example:
|
||||
|
||||
<kbd>
|
||||
<a href="https://codium.ai/images/pr_agent/describe_comment.png">
|
||||
<img src="https://codium.ai/images/pr_agent/describe_comment.png" width="512">
|
||||
</a>
|
||||
</kbd>
|
||||
{width=512}
|
||||
|
||||
<kbd>
|
||||
<a href="https://codium.ai/images/pr_agent/describe_new.png">
|
||||
<img src="https://codium.ai/images/pr_agent/describe_new.png" width="512">
|
||||
</a>
|
||||
</kbd>
|
||||
{width=512}
|
||||
|
||||
|
||||
|
||||
@ -57,29 +49,17 @@ This feature enables you to copy the `changes walkthrough` table to the "Files c
|
||||
|
||||
To copy the `changes walkthrough` table to the "Files changed" tab, you can click on the checkbox that appears PR Description status message below the main PR Description:
|
||||
|
||||
<kbd>
|
||||
<a href="https://codium.ai/images/pr_agent/add_table_checkbox.png">
|
||||
<img src="https://codium.ai/images/pr_agent/add_table_checkbox.png" width="512">
|
||||
</a>
|
||||
</kbd>
|
||||
{width=512}
|
||||
|
||||
If you prefer to have the file summaries appear in the "Files changed" tab on every PR, change the `pr_description.inline_file_summary` parameter 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>
|
||||
<a href="https://codium.ai/images/pr_agent/diffview-table.png">
|
||||
<img src="https://codium.ai/images/pr_agent/diffview-table.png" width="512">
|
||||
</a>
|
||||
</kbd>
|
||||
{width=512}
|
||||
|
||||
- `true`: A collapsable file comment with changes title and a changes summary for each file in the PR.
|
||||
|
||||
<kbd>
|
||||
<a href="https://codium.ai/images/pr_agent/diffview_changes.png">
|
||||
<img src="https://codium.ai/images/pr_agent/diffview_changes.png" width="512">
|
||||
</a>
|
||||
</kbd>
|
||||
{width=512}
|
||||
|
||||
- `false` (`default`): File changes walkthrough will be added only to the "Conversation" tab.
|
||||
|
||||
@ -99,11 +79,7 @@ Now add/edit the custom labels. they should be formatted as follows:
|
||||
* Description: Start the description of with prefix `pr_agent:`, for example: `pr_agent: Description of when AI should suggest this label`.<br>
|
||||
|
||||
The description should be comprehensive and detailed, indicating when to add the desired label. For example:
|
||||
<kbd>
|
||||
<a href="https://codium.ai/images/pr_agent/add_native_custom_labels.png">
|
||||
<img src="https://codium.ai/images/pr_agent/add_native_custom_labels.png" width="768">
|
||||
</a>
|
||||
</kbd>
|
||||
{width=768}
|
||||
|
||||
|
||||
### Markers template
|
||||
@ -126,19 +102,12 @@ pr_agent:walkthrough
|
||||
```
|
||||
The marker `pr_agent:type` will be replaced with the PR type, `pr_agent:summary` will be replaced with the PR summary, and `pr_agent:walkthrough` will be replaced with the PR walkthrough.
|
||||
|
||||
<kbd>
|
||||
<a href="https://codium.ai/images/pr_agent/describe_markers_before.png">
|
||||
<img src="https://codium.ai/images/pr_agent/describe_markers_before.png" width="512">
|
||||
</a>
|
||||
</kbd>
|
||||
{width=512}
|
||||
|
||||
→
|
||||
|
||||
<kbd>
|
||||
<a href="https://codium.ai/images/pr_agent/describe_markers_after.png">
|
||||
<img src="https://codium.ai/images/pr_agent/describe_markers_after.png" width="512">
|
||||
</a>
|
||||
</kbd>
|
||||
{width=512}
|
||||
|
||||
|
||||
**Configuration params**:
|
||||
|
||||
|
||||
@ -7,11 +7,11 @@ It can be invoked manually by commenting on any PR:
|
||||
```
|
||||
For example:
|
||||
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/docs_command.png width="768"></kbd>
|
||||
{width=768}
|
||||
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/docs_components.png width="768"></kbd>
|
||||
{width=768}
|
||||
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/docs_single_component.png width="768"></kbd>
|
||||
{width=768}
|
||||
|
||||
## Configuration options
|
||||
- `docs_style`: The exact style of the documentation (for python docstring). you can choose between: `google`, `numpy`, `sphinx`, `restructuredtext`, `plain`. Default is `sphinx`.
|
||||
|
||||
@ -9,20 +9,12 @@ The tool can be triggered automatically every time a new PR is [opened](../usage
|
||||
|
||||
The code suggestions can be presented as a single comment (via `pr_code_suggestions.summarize=true`):
|
||||
|
||||
<kbd>
|
||||
<a href="https://codium.ai/images/pr_agent/code_suggestions_as_comment.png" target="_blank">
|
||||
<img src="https://codium.ai/images/pr_agent/code_suggestions_as_comment.png" width="512">
|
||||
</a>
|
||||
</kbd>
|
||||
|
||||
{width=512}
|
||||
|
||||
Or as a separate commitable code comment for each suggestion:
|
||||
|
||||
<kbd>
|
||||
<a href="https://codium.ai/images/pr_agent/improve.png" target="_blank">
|
||||
<img src="https://codium.ai/images/pr_agent/improve.png" width="512">
|
||||
</a>
|
||||
</kbd>
|
||||
{width=512}
|
||||
|
||||
|
||||
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.
|
||||
|
||||
@ -6,17 +6,9 @@ The tool can be triggered automatically every time a new PR is [opened](../usage
|
||||
```
|
||||
For example:
|
||||
|
||||
<kbd>
|
||||
<a href="https://codium.ai/images/pr_agent/review_comment.png">
|
||||
<img src="https://codium.ai/images/pr_agent/review_comment.png" width="512">
|
||||
</a>
|
||||
</kbd>
|
||||
{width=512}
|
||||
|
||||
<kbd>
|
||||
<a href="https://codium.ai/images/pr_agent/review3.png">
|
||||
<img src="https://codium.ai/images/pr_agent/review3.png" width="512">
|
||||
</a>
|
||||
</kbd>
|
||||
{width=512}
|
||||
|
||||
|
||||
## Configuration options
|
||||
@ -70,11 +62,7 @@ For invoking the incremental mode, the following command can be used:
|
||||
```
|
||||
Note that the incremental mode is only available for GitHub.
|
||||
|
||||
<kbd>
|
||||
<a href="https://codium.ai/images/pr_agent/incremental_review_2.png">
|
||||
<img src="https://codium.ai/images/pr_agent/incremental_review_2.png" width="512">
|
||||
</a>
|
||||
</kbd>
|
||||
{width=512}
|
||||
|
||||
### PR Reflection
|
||||
|
||||
@ -84,23 +72,11 @@ By invoking:
|
||||
```
|
||||
The tool will first ask the author questions about the PR, and will guide the review based on their answers.
|
||||
|
||||
<kbd>
|
||||
<a href="https://codium.ai/images/pr_agent/reflection_questions.png">
|
||||
<img src="https://codium.ai/images/pr_agent/reflection_questions.png" width="512">
|
||||
</a>
|
||||
</kbd>
|
||||
{width=512}
|
||||
|
||||
<kbd>
|
||||
<a href="https://codium.ai/images/pr_agent/reflection_answers.png">
|
||||
<img src="https://codium.ai/images/pr_agent/reflection_answers.png" width="512">
|
||||
</a>
|
||||
</kbd>
|
||||
{width=512}
|
||||
|
||||
<kbd>
|
||||
<a href="https://codium.ai/images/pr_agent/reflection_insights.png">
|
||||
<img src="https://codium.ai/images/pr_agent/reflection_insights.png" width="512">
|
||||
</a>
|
||||
</kbd>
|
||||
{width=512}
|
||||
|
||||
|
||||
## Usage Tips
|
||||
|
||||
@ -5,7 +5,8 @@ For example:
|
||||
|
||||
`Global Search` for a method called `chat_completion`:
|
||||
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/similar_code_global2.png width="768"></kbd>
|
||||
{width=768}
|
||||
|
||||
|
||||
PR-Agent will examine the code component and will extract the most relevant keywords to search for similar code:
|
||||
|
||||
@ -16,11 +17,12 @@ PR-Agent will examine the code component and will extract the most relevant keyw
|
||||
|
||||
Search result link example:
|
||||
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/code_search_result_single.png width="768"></kbd>
|
||||
{width=768}
|
||||
|
||||
|
||||
`Organization Search`:
|
||||
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/similar_code_org.png width="768"></kbd>
|
||||
{width=768}
|
||||
|
||||
|
||||
## How to use
|
||||
@ -47,11 +49,11 @@ It can be invoked automatically from the analyze table, can be accessed by:
|
||||
/analyze
|
||||
```
|
||||
Choose the components you want to find similar code for, and click on the `similar` checkbox.
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/analyze_similar.png width="768"></kbd>
|
||||
{width=768}
|
||||
|
||||
If you are looking to search for similar code in the organization's codebase, you can click on the `Organization` checkbox, and it will invoke a new search command just for the organization's codebase.
|
||||
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/similar_code_global.png width="768"></kbd>
|
||||
{width=768}
|
||||
|
||||
|
||||
## Configuration options
|
||||
|
||||
@ -6,11 +6,11 @@ It can be invoked manually by commenting on any PR:
|
||||
```
|
||||
For example:
|
||||
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/similar_issue_original_issue.png width="768"></kbd>
|
||||
{width=768}
|
||||
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/similar_issue_comment.png width="768"></kbd>
|
||||
{width=768}
|
||||
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/similar_issue.png width="768"></kbd>
|
||||
{width=768}
|
||||
|
||||
Note that to perform retrieval, the `similar_issue` tool indexes all the repo previous issues (once).
|
||||
|
||||
|
||||
@ -10,11 +10,11 @@ To get a list of the components that changed in the PR, use the [`analyze`](./an
|
||||
|
||||
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>
|
||||
{width=704}
|
||||
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/test2.png width="768"></kbd>
|
||||
{width=768}
|
||||
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/test3.png width="768"></kbd>
|
||||
{width=768}
|
||||
|
||||
**Notes**
|
||||
- Language that are currently supported by the tool: Python, Java, C++, JavaScript, TypeScript.
|
||||
|
||||
@ -6,10 +6,9 @@ It can be invoked manually by commenting on any PR:
|
||||
```
|
||||
For example:
|
||||
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/update_changelog_comment.png width="768"></kbd>
|
||||
|
||||
<kbd><img src=https://codium.ai/images/pr_agent/update_changelog.png width="768"></kbd>
|
||||
{width=768}
|
||||
|
||||
{width=768}
|
||||
|
||||
## Configuration options
|
||||
|
||||
|
||||
Reference in New Issue
Block a user