Merge pull request #54 from Codium-ai/tr/readme_update
Update README.md with Detailed Tool Description and Images
27
README.md
@ -9,10 +9,30 @@
|
|||||||
|
|
||||||
[](https://github.com/Codium-ai/pr-agent/blob/main/LICENSE)
|
[](https://github.com/Codium-ai/pr-agent/blob/main/LICENSE)
|
||||||
[](https://discord.com/channels/1057273017547378788/1126104260430528613)
|
[](https://discord.com/channels/1057273017547378788/1126104260430528613)
|
||||||
|
|
||||||
CodiumAI `pr-agent` is an open-source tool aiming to help developers review PRs faster and more efficiently. It automatically analyzes the PR, provides feedback and suggestions, and can answer free-text questions.
|
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
<div align="left">
|
||||||
|
|
||||||
|
CodiumAI `pr-agent` is an open-source tool aiming to help developers review PRs faster and more efficiently. It automatically analyzes the PR and can provide several types of feedback:
|
||||||
|
|
||||||
|
**Auto-Description**: Automatically generating PR description - name, type, summary, and code walkthrough.
|
||||||
|
\
|
||||||
|
**PR Review**: Feedback about the PR main theme, type, relevant tests, security issues, focused, and various suggestions for the PR content.
|
||||||
|
\
|
||||||
|
**Question Answering**: Answering free-text questions about the PR.
|
||||||
|
\
|
||||||
|
**Code Suggestion**: Committable code suggestions for improving the PR.
|
||||||
|
|
||||||
|
Example results:
|
||||||
|
</div>
|
||||||
|
<div align="center">
|
||||||
|
<p float="center">
|
||||||
|
<img src="./pics/pr_reviewer_1.png" width="800">
|
||||||
|
</p>
|
||||||
|
<p float="center">
|
||||||
|
<img src="./pics/pr_code_suggestions.png" width="800">
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<div align="left">
|
||||||
|
|
||||||
- [Live demo](#live-demo)
|
- [Live demo](#live-demo)
|
||||||
- [Overview](#overview)
|
- [Overview](#overview)
|
||||||
@ -22,6 +42,7 @@ CodiumAI `pr-agent` is an open-source tool aiming to help developers review PRs
|
|||||||
- [How it works](#how-it-works)
|
- [How it works](#how-it-works)
|
||||||
- [Roadmap](#roadmap)
|
- [Roadmap](#roadmap)
|
||||||
- [Similar projects](#similar-projects)
|
- [Similar projects](#similar-projects)
|
||||||
|
</div>
|
||||||
|
|
||||||
## Live demo
|
## Live demo
|
||||||
|
|
||||||
|
BIN
pics/Icon-7.png
Before Width: | Height: | Size: 100 KiB |
Before Width: | Height: | Size: 102 KiB |
BIN
pics/main_pic_4_tools.gif
Normal file
After Width: | Height: | Size: 260 KiB |
BIN
pics/pr_auto_description.png
Normal file
After Width: | Height: | Size: 335 KiB |
BIN
pics/pr_code_suggestions.png
Normal file
After Width: | Height: | Size: 193 KiB |
Before Width: | Height: | Size: 137 KiB After Width: | Height: | Size: 161 KiB |
Before Width: | Height: | Size: 267 KiB |
BIN
pics/pr_reviewer_1.png
Normal file
After Width: | Height: | Size: 185 KiB |
BIN
pics/pr_reviewer_2.png
Normal file
After Width: | Height: | Size: 162 KiB |
Before Width: | Height: | Size: 42 KiB |