Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Bogdan Stanga committed Nov 22, 2024
1 parent 1b05b5c commit 5b559af
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 11 deletions.
37 changes: 26 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,23 @@ Optimize your code review process with Presubmit's AI Code Reviewer that catches

- 🔍 **Instant, In-depth PR Analysis**: Catches bugs, security issues, and optimization opportunities in real-time
- 🎯 **Focus on What Matters**: Let AI handle the basics while humans focus on architecture and complex logic
-**Lightning-Fast Setup**: Up and running in 2 minutes with GitHub Actions
- 💬 **Interactive & Smart**: Responds to questions and generates code suggestions right in your PR
-**Title and description generation**: Save time by having the AI generate meaningful title and description for your PR
- 💬 **Interactive & Smart**: Responds to questions and generates code suggestions right in your PR
-**Lightning-Fast Setup**: Up and running in 2 minutes with GitHub Actions

<br/>

> 🤝 **Note**: Presubmit is designed to complement human reviewers, not replace them. It helps catch security issues and bugs early on while also providing context about the overall change, making the human review process more efficient.
<br/>

![review example](https://github.com/presubmit/ai-reviewer/blob/main/assets/review_example.png?raw=true)
## Example

See example [Pull Request review](https://github.com/presubmit/ebank-backend/pull/13).

<br />

![AI Code Review example](https://github.com/presubmit/ai-reviewer/blob/main/assets/review_example-2.png?raw=true)

## Usage

Expand Down Expand Up @@ -88,19 +94,28 @@ The action requires:

### 🛡️ Security & Quality

- **Vulnerability Detection**: Catches security issues and leaked secrets
- **Best Practices**: Enforces coding standards and security guidelines
- **Vulnerability Detection**: Catches security issues and leaked
secrets
- **Best Practices**: Enforces coding standards and security
guidelines
- **Performance**: Identifies potential bottlenecks and optimizations
- **Documentation**: Ensures proper code documentation and clarity

### ⚡ Developer Experience
### ⚙️ Configurable

- Mention `@presubmit` in PR title for auto-generation
- Disable reviews with `@presubmit ignore` comment
- Configurable review depth and focus areas
- Customizable rules and preferences

- **2-Minute Setup**: Quick integration with GitHub Actions
- **Smart PR Titles**: Auto-generates descriptive and meaningful titles
- **Real-time**: Instant feedback on your pull requests
- **24/7 Available**: Round-the-clock code reviews
### ⚡ Seamless Integration

_Production-ready, secure, and ready to review your code!_ 🚀
- 2-minute setup with GitHub Actions
- Works with all major LLM providers (Claude, GPT-4, Gemini)
- Instant feedback on every PR
- Zero maintenance required

<br/>

## Show Your Support! ⭐

Expand Down
Binary file added assets/reivew_example_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5b559af

Please sign in to comment.