Skip to content

Commit

Permalink
docs(readme): new code review page
Browse files Browse the repository at this point in the history
  • Loading branch information
alexsoyes committed Jul 4, 2024
1 parent 2d4d19d commit ee26b1f
Show file tree
Hide file tree
Showing 4 changed files with 68 additions and 27 deletions.
64 changes: 37 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,33 +16,35 @@ The GitHub Repository is updated weekly!

Get started easily with the **AI Driven Dev Community**:

- [**0#** 🚀 Get started](#0--get-started)
- [Best practices](#best-practices)
- [Tools to install](#tools-to-install)
- [Example workflow of an AI Driven Dev](#example-workflow-of-an-ai-driven-dev)
- [**1#** 🤖 Custom AI for developers](#1--custom-ai-for-developers)
- [RAG Developer](#rag-developer)
- [Best Instructions](#best-instructions)
- [Custom GPT Agents](#custom-gpt-agents)
- [**2#** ⭐️ Developer prompts list](#2-️-developer-prompts-list)
- [Usage](#usage)
- [Installation](#installation)
- [Prompts for developers (in IDE)](#prompts-for-developers-in-ide)
- [Prompts for developers (in Chat)](#prompts-for-developers-in-chat)
- [Coding with AI CLI](#coding-with-ai-cli)
- [**3#** 🛠️ Install AI Toolbox for software engineers](#3-️-install-ai-toolbox-for-software-engineers)
- [AIDDC Scripts](#aiddc-scripts)
- [Website scraper](#website-scraper)
- [Private prompts](#private-prompts)
- [VSCode snippets](#vscode-snippets)
- [**4#** ❤️ Get support](#4-️-get-support)
- [Discord](#discord)
- [✨ Courses (in french)](#-courses-in-french)
- [Links](#links)
- [AIDDC Video Demo (in french)](#aiddc-video-demo-in-french)
- [**5#** 🚀 Super easy contribution](#5--super-easy-contribution)
- [5 steps to contribute in 2 minutes](#5-steps-to-contribute-in-2-minutes)
- [No -fork contributions](#no---fork-contributions)
- [AI Driven Dev Community](#ai-driven-dev-community)
- [**0#** 🚀 Get started](#0--get-started)
- [Best practices](#best-practices)
- [Tools to install](#tools-to-install)
- [Example workflow of an AI Driven Dev](#example-workflow-of-an-ai-driven-dev)
- [**1#** 🤖 Custom AI for developers](#1--custom-ai-for-developers)
- [RAG Developer](#rag-developer)
- [Best Instructions](#best-instructions)
- [Custom GPT Agents](#custom-gpt-agents)
- [**2#** ⭐️ Developer prompts list](#2-️-developer-prompts-list)
- [Usage](#usage)
- [Installation](#installation)
- [Prompts for developers (in IDE)](#prompts-for-developers-in-ide)
- [Prompts for developers (in Chat)](#prompts-for-developers-in-chat)
- [Coding with AI CLI](#coding-with-ai-cli)
- [Code Review using AI](#code-review-using-ai)
- [**3#** 🛠️ Install AI Toolbox for software engineers](#3-️-install-ai-toolbox-for-software-engineers)
- [AIDDC Scripts](#aiddc-scripts)
- [Website scraper](#website-scraper)
- [Private prompts](#private-prompts)
- [VSCode snippets](#vscode-snippets)
- [**4#** ❤️ Get support](#4-️-get-support)
- [Discord](#discord)
- [✨ Courses (in french)](#-courses-in-french)
- [Links](#links)
- [AIDDC Video Demo (in french)](#aiddc-video-demo-in-french)
- [**5#** 🚀 Super easy contribution](#5--super-easy-contribution)
- [5 steps to contribute in 2 minutes](#5-steps-to-contribute-in-2-minutes)
- [No -fork contributions](#no---fork-contributions)

## **0#** 🚀 Get started

Expand Down Expand Up @@ -209,6 +211,14 @@ Use the CLI to code with the AI when you need to write in multiple files at once

![Aider - Split file](images/aider-split-file.gif)

### Code Review using AI

AI is able to make good and clean code reviews for you, automaticly bound to your commit deployments.

- [AI Code Review Guide](resources/guide/code-review-ai.md)

![PR Agent by Codium](images/code-review/code-review-pr-agent.png)

## **3#** 🛠️ Install AI Toolbox for software engineers

Clone this repo: `git clone git@github.com:alexsoyes/ai-driven-dev-community.git`
Expand Down
Binary file added images/code-review/code-review-coderabbit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/code-review/code-review-pr-agent.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 31 additions & 0 deletions resources/guide/code-review-ai.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Code Review using AI

This document tries to help developers regarding code reviews using AI.

**A large amount of tools have been tested, those are the best** (ihmo).

- [Code Review using AI](#code-review-using-ai)
- [GitHub Action : PR-Agent (by Codium) - Free](#github-action--pr-agent-by-codium---free)
- [App : CodeRabbit - 15$/mo](#app--coderabbit---15mo)

## GitHub Action : PR-Agent (by Codium) - Free

[PR Agent by Codium](https://github.com/Codium-ai/pr-agent) is the code reviewing tool we are using in this repository.

It is connected to OpenAI and is able to review are code in a cool way.

*Of course you need an OpenAI API key to make it work.*

![PR Agent - Codium](../../images/code-review/code-review-pr-agent.png)

> [PR-Agent Review Example here](https://github.com/alexsoyes/ai-driven-dev-community/pull/7)
## App : CodeRabbit - 15$/mo

![CodeRabbit](../../images/code-review/code-review-coderabbit.png)

This tool impresses me so much.

[CodeRabbit](https://coderabbit.ai/) has the advantage of always providing a suggestion that you can apply.

> [CodeRabbit Review Example here](https://github.com/alexsoyes/ai-driven-dev-community/pull/7)

0 comments on commit ee26b1f

Please sign in to comment.