Skip to content

Commit 2d2f4c0

Browse files
bitoandybitoandy
authored
Merge pull request #39 from gitbito/trulyfurqan-patch-3
README.md redesigned
2 parents fae5262 + a7fbff3 commit 2d2f4c0

File tree

1 file changed

+190
-42
lines changed

1 file changed

+190
-42
lines changed

‎README.md

Lines changed: 190 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,230 @@
1-
# AI Code Review Agent
1+
<!-- PROJECT SHIELDS -->
2+
<!--
3+
*** I'm using markdown "reference style" links for readability.
4+
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
5+
*** See the bottom of this document for the declaration of the reference variables
6+
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
7+
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
8+
-->
9+
10+
[![Visit bito.ai][bito-shield]][bito-url]
11+
[![Contributors][contributors-shield]][contributors-url]
12+
[![Forks][forks-shield]][forks-url]
13+
[![Stargazers][stars-shield]][stars-url]
14+
[![Issues][issues-shield]][issues-url]
15+
[![MIT License][license-shield]][license-url]
16+
17+
<!-- PROJECT LOGO -->
18+
<br />
19+
<div align="center">
20+
<a href="https://bito.ai/product/ai-code-review-agent/">
21+
<img src="https://github.com/user-attachments/assets/d06b4dcf-9234-4d9a-be65-1e6f1ecfe5fa" alt="Logo" width="150">
22+
</a>
23+
24+
<h3 align="center">AI Code Review Agent</h3>
25+
26+
<p align="center">
27+
On-demand, context-aware code reviews in your Git workflow or IDE as you code.
28+
<br />
29+
<a href="https://docs.bito.ai/bito-dev-agents/ai-code-review-agent"><strong>Explore the docs »</strong></a>
30+
<br />
31+
<br />
32+
<a href="https://www.youtube.com/watch?v=ZrfSDANgboU">View a demo</a>
33+
·
34+
<a href="https://alpha.bito.ai/home/welcome">Signup for free</a>
35+
·
36+
<a href="https://bit.ly/BitoSlack">Join the community in Slack</a>
37+
</p>
38+
</div>
39+
40+
<br />
41+
42+
<!-- TABLE OF CONTENTS -->
43+
<details>
44+
<summary>Table of contents</summary>
45+
<ol>
46+
<li>
47+
<a href="#about-the-project">About the project</a>
48+
</li>
49+
<li>
50+
<a href="#getting-started">Getting started</a>
51+
</li>
52+
<li>
53+
<a href="#why-use-ai-for-code-review">Why use AI for code review?</a>
54+
</li>
55+
<li>
56+
<a href="#key-features">Key features</a>
57+
</li>
58+
<li>
59+
<a href="#screenshots">Screenshots</a>
60+
</li>
61+
<li>
62+
<a href="#need-support-were-ready-to-assist">Need support? We're ready to assist!</a>
63+
</li>
64+
65+
</ol>
66+
</details>
67+
68+
<br />
69+
70+
<!-- ABOUT THE PROJECT -->
71+
72+
## About the project
73+
74+
> _Click the image below to watch the demo video on YouTube._
75+
76+
[![Bito's AI Code Review Agent](https://img.youtube.com/vi/ZrfSDANgboU/0.jpg)](https://www.youtube.com/watch?v=ZrfSDANgboU)
77+
78+
Bito’s **[AI Code Review Agent](https://bito.ai/ai-code-review-agent/)** is the first agent built with **Bito’s AI Agent framework and engine**. It is an automated AI assistant (powered by Anthropic’s Claude Sonnet 3.5) that will review your team’s code; it spots bugs, issues, code smells, and security vulnerabilities in Pull/Merge Requests (PR/MR) and provides high-quality suggestions to fix them.
79+
80+
It seamlessly **integrates with Git providers such as GitHub, GitLab, and Bitbucket**, automatically posting recommendations directly as comments within the corresponding Pull Request. It includes real-time recommendations from static analysis and OSS vulnerability tools such as fbinfer, Dependency-Check, etc., and can include high severity suggestions from other 3rd party tools you use such as Snyk or Sonar.
81+
82+
The AI Code Review Agent is equipped with advanced code understanding capabilities, allowing it to analyze your entire codebase in depth. This results in more context-aware insights and suggestions, providing a tailored and highly relevant code review experience that aligns with the specific needs of your project.
83+
84+
The AI Code Review Agent ensures a secure and confidential experience without compromising on reliability. Bito neither reads nor stores your code, and none of your code is used for AI model training. Learn more about our **[Privacy & Security practices](https://docs.bito.ai/privacy-and-security)**.
85+
86+
<br />
87+
88+
<!-- GETTING STARTED -->
89+
90+
## Getting started
91+
92+
There are three ways to use the AI Code Review Agent.
293

3-
## Overview
4-
Bito’s **[AI Code Review Agent](https://bito.ai/ai-code-review-agent/)** is the first agent built with **Bito’s AI Agent framework and engine**. It is an automated AI assistant (powered by OpenAI’s GPT-4 and Anthropic’s Claude 2.1) that will review your team’s code; it spots bugs, issues, code smells, and security vulnerabilities in Pull/Merge Requests (PR/MR) and provides high-quality suggestions to fix them.
94+
**1- Bito Cloud:** Offers a hassle-free experience with no installation required on your machine.
95+
[Follow this guide](https://docs.bito.ai/bito-dev-agents/ai-code-review-agent/getting-started/install-run-using-bito-cloud)
596

6-
It seamlessly **integrates with Git providers such as GitHub, GitLab, and Bitbucket (coming soon)**, automatically posting recommendations directly as comments within the corresponding Pull Request. It includes real-time recommendations from static analysis and OSS vulnerability tools such as fbinfer, Dependency-Check, etc., and can include high severity suggestions from other 3rd party tools you use such as Snyk or Sonar.
97+
**2- Self-hosted service via CLI, webhooks, or GitHub Actions:** Ideal for deployments within your own infrastructure.
98+
[Follow this guide](https://docs.bito.ai/bito-dev-agents/ai-code-review-agent/getting-started/install-run-as-a-self-hosted-service)
799

8-
The upcoming Bito's **Native Code RAG** feature will enable the AI Code Review Agent to understand your entire codebase, offering better context-aware analysis and suggestions for a more personalized and contextually relevant code review experience.
100+
**3- AI code reviews in IDE:** Get instant feedback on your code changes directly within VS Code or JetBrains IDEs.
101+
[Follow this guide](https://docs.bito.ai/bito-dev-agents/ai-code-review-agent/getting-started/ai-code-reviews-in-ide)
9102

10-
AI Code Review Agent ensures a secure and confidential experience without compromising on reliability. Bito neither reads nor stores your code, and none of your code is used for AI model training. Learn more about our **[Privacy & Security practices](https://docs.bito.ai/privacy-and-security)**.
103+
<br />
11104

12-
**[View Documentation](https://docs.bito.ai/bito-dev-agents/ai-code-review-agent)**
105+
## Why use AI for code review?
13106

14-
## Watch Video on YouTube
15-
Right-click the image below and select "Open link in new tab" to view the **[YouTube video](https://youtu.be/QzMFfl2KRJI)** on a new page.
107+
- **Time saving:** Can reduce code review time by up to 50%.
108+
- **Quality improvement:** Enhances code review quality.
109+
- **Support role:** Assists senior software engineers, focusing on mundane review tasks.
16110

17-
[![Bito's AI Code Review Agent](https://img.youtube.com/vi/QzMFfl2KRJI/0.jpg)](https://www.youtube.com/watch?v=QzMFfl2KRJI)
111+
<br />
18112

19-
## Getting Started
20-
There are two ways to use the AI Code Review Agent.
113+
## Key features
21114

22-
**1- Bito Cloud:** Offers a hassle-free experience with no installation required on your machine.
23-
[Follow this guide](https://docs.bito.ai/bito-dev-agents/ai-code-review-agent/getting-started/install-run-using-bito-cloud)
24-
25-
**2- Self-hosted service via CLI, webhooks, or GitHub Actions:** Ideal for deployments within your own infrastructure.
26-
[Follow this guide](https://docs.bito.ai/bito-dev-agents/ai-code-review-agent/getting-started/install-run-as-a-self-hosted-service)
115+
- **AI code review:** AI analyzes your code changes to identify issues related to security, performance, scalability, optimization, impact on existing features, code structure, and coding standards.
116+
- **Deep code understanding:** Deep understanding of your code including libraries, frameworks, functionality to improve code review.
117+
- **Real-time feedback:** Get instant code review feedback in VS Code and all JetBrains IDEs.
118+
- **Pull request (PR) summary:** Quick overview of pull request.
119+
- **Feedback in pull requests**: Posts review comments directly in pull requests.
120+
- **Estimated effort to review:** Evaluates complexity for better planning.
121+
- **Tailored code suggestions:** Provides specific line-by-line code improvement suggestions.
122+
- **Static code analysis:** Uses tools like fbinfer, supports integration with tools like Sonar and more.
123+
- **Security vulnerability check:** Uses tools like OWASP Dependency-Check for detecting high-severity vulnerabilities in the open source projects you use.
27124

28-
## Why Use AI for Code Review?
29-
- **Time Saving**: Can reduce code review time by up to 50%.
30-
- **Quality Improvement**: Enhances code review quality.
31-
- **Support Role**: Assists senior software engineers, focusing on mundane review tasks.
32-
33-
## Key Features
34-
- **Pull Request (PR) Summary**: Quick overview of PRs.
35-
- **Estimated Effort to Review**: Evaluates complexity for better planning.
36-
- **Code Improvement**: Analyzes security, performance, scalability, optimization, potential breakages, code structure, and coding standards.
37-
- **Tailored Code Suggestions**: Provides specific line-by-line code improvement advice.
38-
- **Static Code Analysis**: Uses tools like fbinfer, supports integration with tools like Sonar.
39-
- **Open Source Security Vulnerabilities**: Checks for high-severity vulnerabilities using tools like OWASP Dependency-Check.
40-
- **Feedback in PRs/MRs**: Posts review comments directly in PRs or MRs.
41-
- **Real-Time Feedback**: Upcoming feature for instant IDE feedback.
125+
<br />
42126

43127
## Screenshots
128+
129+
44130
### Screenshot # 1
45-
> *Code review automatically added as comment when a pull request is created.*
46131

47-
![AI Code Review Agent's output screenshot](https://github.com/gitbito/codereviewagent/assets/22556762/c465ceab-9164-4eb3-b899-3c824773b194)
132+
> _AI-generated pull request (PR) summary_
133+
<br />
134+
135+
<kbd>
136+
<img src="https://github.com/user-attachments/assets/9ef02020-4382-4b4a-8c08-9d647b5da78f" alt="AI-generated pull request (PR) summary" />
137+
</kbd>
138+
139+
<br />
48140

49141
---
50142

143+
<br />
144+
51145
### Screenshot # 2
52-
> *Code review manually triggered using **/review** command.*
53146

54-
![AI Code Review Agent's output screenshot](https://github.com/gitbito/codereviewagent/assets/22556762/dc84121a-e79d-4893-bb4a-c95a5ca434b3)
147+
> _Code review manually triggered using **/review** command._
148+
<br />
149+
150+
<kbd>
151+
<img src="https://github.com/user-attachments/assets/4c53b4eb-474e-40aa-b9fd-f10d3ecb022a" alt="Use the /review command to manually trigger a code review." />
152+
</kbd>
153+
154+
<br />
55155

56156
---
57157

158+
<br />
159+
58160
### Screenshot # 3
59-
> *Line-by-line code suggestions to quickly fix issues.*
60161

61-
![AI Code Review Agent's output screenshot](https://github.com/gitbito/codereviewagent/assets/22556762/df8f422e-5ba3-4e24-ae1e-32d3cfd4ad40)
162+
> _Using tools like Facebook’s open source fbinfer (available out of the box), the Agent thoroughly analyzes your language-specific code and suggests fixes. Tools you use such as Sonar can also be configured._
163+
<br />
164+
165+
<kbd>
166+
<img src="https://github.com/gitbito/codereviewagent/assets/22556762/1afa9f7e-7f1a-4644-b2fc-36de23aa54ea" alt="Static Code Analysis reports inside AI code review" />
167+
</kbd>
168+
169+
<br />
62170

63171
---
64172

173+
<br />
174+
65175
### Screenshot # 4
66-
> *Using tools like Facebook’s open source fbinfer (available out of the box), it analyzes your code, specific to the language, thoroughly and suggests fixes. Tools you use such as Sonar can also be configured.*
67176

68-
![AI Code Review Agent's output screenshot](https://github.com/gitbito/codereviewagent/assets/22556762/1afa9f7e-7f1a-4644-b2fc-36de23aa54ea)
177+
> _The Agent checks your code in real-time for high-severity security vulnerabilities using OWASP Dependency-Check (available out of the box). Additional tools like Snyk or GitHub Dependabot can also be configured._
178+
<br />
179+
180+
<kbd>
181+
<img src="https://github.com/user-attachments/assets/09cee3f1-8b86-4a2d-b509-a0fbab361ce7" alt="AI Code Review Agent checks your code in real-time for high-severity security vulnerabilities using OWASP Dependency-Check" />
182+
</kbd>
183+
184+
<br />
69185

70186
---
71187

188+
<br />
189+
72190
### Screenshot # 5
73-
> *The Agent checks real-time for the latest high severity security vulnerabilities in your code, using OWASP Dependency-Check (available out of the box). Additional tools such as Snyk, or GitHub Dependabot can also be configured.*
74191

75-
![AI Code Review Agent's output screenshot](https://github.com/gitbito/codereviewagent/assets/22556762/fca4a038-2281-41bf-b0eb-3c43136a68a5)
192+
> _Get instant feedback on your code changes directly within VS Code or JetBrains IDEs._
193+
<br />
194+
195+
<kbd>
196+
<img src="https://github.com/user-attachments/assets/c6c44cf0-c6e0-4f58-8ab0-de7dc29abb99" alt="Get instant feedback on your code changes directly within VS Code or JetBrains IDEs." />
197+
</kbd>
198+
199+
<br />
76200

77201
---
78202

79-
## Need Support? We're Ready to Assist!
203+
<br />
204+
205+
## Need support? We're ready to assist!
206+
80207
For comprehensive information and guidance on the AI Code Review Agent, including installation and configuration instructions, please refer to our detailed **[documentation available here](https://docs.bito.ai/bito-dev-agents/ai-code-review-agent)**. Should you require further assistance or have any inquiries, our support team is readily available to assist you.
81208

82209
Feel free to reach out to us via email at: **[support@bito.ai](mailto:support@bito.ai)**
210+
211+
212+
213+
214+
215+
<!-- MARKDOWN LINKS & IMAGES -->
216+
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
217+
218+
[bito-shield]: https://img.shields.io/badge/Visit%20bito.ai-black.svg?style=for-the-badge&colorB=%232baaff
219+
[bito-url]: https://bito.ai/
220+
221+
[contributors-shield]: https://img.shields.io/github/contributors/gitbito/CodeReviewAgent.svg?style=for-the-badge
222+
[contributors-url]: https://github.com/gitbito/CodeReviewAgent/graphs/contributors
223+
[forks-shield]: https://img.shields.io/github/forks/gitbito/CodeReviewAgent.svg?style=for-the-badge
224+
[forks-url]: https://github.com/gitbito/CodeReviewAgent/network/members
225+
[stars-shield]: https://img.shields.io/github/stars/gitbito/CodeReviewAgent.svg?style=for-the-badge
226+
[stars-url]: https://github.com/gitbito/CodeReviewAgent/stargazers
227+
[issues-shield]: https://img.shields.io/github/issues/gitbito/CodeReviewAgent.svg?style=for-the-badge
228+
[issues-url]: https://github.com/gitbito/CodeReviewAgent/issues
229+
[license-shield]: https://img.shields.io/github/license/gitbito/CodeReviewAgent.svg?style=for-the-badge
230+
[license-url]: https://github.com/gitbito/CodeReviewAgent?tab=MIT-1-ov-file#readme

0 commit comments

Comments
 (0)