xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-04 12:50:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #12 from Codium-ai/readme-content-fixes

Browse Source 
fix the configuration order in the outline, section break fixes, text…
This commit is contained in:
Almog Lavi
2023-07-06 18:15:48 +03:00
committed by GitHub
parent 933f2ca093 270912d41e
commit f293717827
1 changed files with 2 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -12,14 +12,14 @@ CodiumAI `pr-agent` is an open-source tool is powered by GPT-4 aming to help dev
</div> </div>
- [Quickstart](#Quickstart) - [Quickstart](#Quickstart)
- [Configuration](#Configuration)
- [Usage and Tools](#usage-and-tools) - [Usage and Tools](#usage-and-tools)
- [Configuration](#Configuration)
- [Roadmap](#roadmap) - [Roadmap](#roadmap)
- [Similar projects](#similar-projects) - [Similar projects](#similar-projects)
## Live demo ## Live demo
Experience GPT-4 powered PR review on your public Github repository with our hosted pr-agent. To try it, mention @CodiumAI-Agent in a PR comment! The agent will generate the review response ([see details in the Usage section](https://github.com/Codium-ai/pr-agent#usage-and-tools)). Experience GPT-4 powered PR review on your public Github repository with our hosted pr-agent. To try it, mention @CodiumAI-Agent in a PR comment! The agent will generate the review in response ([see details in the Usage section](#usage-and-tools)).
![Review generation process](./pics/pr-agent-review-process1.gif) ![Review generation process](./pics/pr-agent-review-process1.gif)
@ -218,8 +218,6 @@ This is how a typical output of the PR Reviewer looks like:
This tool answers free-text questions about the PR. This is how a typical output of the PR Q&A looks like: This tool answers free-text questions about the PR. This is how a typical output of the PR Q&A looks like:
---
**Question**: summarize for me the PR in 4 bullet points **Question**: summarize for me the PR in 4 bullet points
**Answer**: **Answer**:
@ -262,13 +260,9 @@ extended_code_suggestions=false
This is a comparison of the regular and extended code suggestions modes: This is a comparison of the regular and extended code suggestions modes:
---
- **relevant file:** sql.py - **relevant file:** sql.py
- **suggestion content:** Remove hardcoded sensitive information like username and password. Use environment variables or a secure method to store these values. [important] - **suggestion content:** Remove hardcoded sensitive information like username and password. Use environment variables or a secure method to store these values. [important]
---
Example for extended suggestion: Example for extended suggestion:
- **relevant file:** sql.py - **relevant file:** sql.py