mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-07-04 04:40:38 +08:00
Readme
This commit is contained in:
@ -28,6 +28,7 @@ We are very happy to share our new paper:
|
|||||||
Go checkout our official implementation [here](https://github.com/Codium-ai/AlphaCodium)
|
Go checkout our official implementation [here](https://github.com/Codium-ai/AlphaCodium)
|
||||||
|
|
||||||
### Jan 17, 2024
|
### Jan 17, 2024
|
||||||
|
- 💎 Inline file summary - The `describe` tool now supports 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 now can present suggestion 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.
|
- The `improve` tool now can present suggestion 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:
|
- 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:
|
||||||
```
|
```
|
||||||
@ -157,6 +158,7 @@ See the [Tools Guide](./docs/TOOLS_GUIDE.md) for a detailed description of the d
|
|||||||
| | ⮑ [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: |
|
| | ⮑ [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: |
|
| | Ask | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
||||||
| | Describe | :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: | :white_check_mark: | :white_check_mark: |
|
||||||
| | Improve | :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: |
|
| | ⮑ Extended | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
||||||
| | Reflect and Review | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
| | Reflect and Review | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
||||||
|
@ -48,6 +48,16 @@ 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.
|
- `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".
|
- `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 💎
|
||||||
|
To enable inline file summary, set `pr_description.inline_file_summary=true` in the configuration file.
|
||||||
|
|
||||||
|
When the feature is enabled, PR-Agent Pro will add a collapsable summary of each file change in the "Files changed" tab.
|
||||||
|
This will enable you to quickly understand the changes in each file, while reviewing the code changes (diff view).
|
||||||
|
|
||||||
|
<kbd><img src=https://codium.ai/images/pr_agent/diffview_changes.png width="768"></kbd>
|
||||||
|
|
||||||
|
*Note that this feature is currently available only for GitHub.
|
||||||
|
|
||||||
|
|
||||||
### Handle custom labels from the Repo's labels page :gem:
|
### Handle custom labels from the Repo's labels page :gem:
|
||||||
> This feature is available only in PR-Agent Pro
|
> This feature is available only in PR-Agent Pro
|
||||||
|
@ -56,6 +56,7 @@ enable_help_text=true
|
|||||||
## changes walkthrough section
|
## changes walkthrough section
|
||||||
enable_semantic_files_types=true
|
enable_semantic_files_types=true
|
||||||
collapsible_file_list='adaptive' # true, false, 'adaptive'
|
collapsible_file_list='adaptive' # true, false, 'adaptive'
|
||||||
|
inline_file_summary=true # Pro feature
|
||||||
# markers
|
# markers
|
||||||
use_description_markers=false
|
use_description_markers=false
|
||||||
include_generated_by_header=true
|
include_generated_by_header=true
|
||||||
|
Reference in New Issue
Block a user