# openai-code-review

**Repository Path**: Minh-X/openai-code-review

## Basic Information

- **Project Name**: openai-code-review
- **Description**: 本项目是一个基于AI的代码评审工具，能够自动对代码提交进行评审，并提供详细的评审意见。项目主要分为两个模块：openai-code-review-sdk 和 openai-code-review-demo
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-09-07
- **Last Updated**: 2025-07-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AI 自动评审提交的代码

## 项目概述
一个基于AI的代码评审工具，能够自动对代码提交进行评审，并提供详细的评审意见。项目主要分为两个模块：`openai-code-review-sdk` 和 `openai-code-review-demo`。

效果如下
提交的代码：
![img_code.png](img_code.png)
  
评审结果：
![img_sug.png](img_sug.png)

## 模块结构
- **openai-code-review-sdk**: 提供核心的代码评审功能，包括与AI模型的交互和评审逻辑。
- **openai-code-review-demo**: 展示如何使用`openai-code-review-sdk`进行代码评审。

## 依赖
项目依赖于以下库：
- **oapi-java-sdk**: 用于与AI模型进行交互的Java SDK。

## 主要功能
- 自动评审代码提交，提供详细的评审意见。
- 支持多种编程语言和场景的代码评审。

## 使用方法
### 1. 引入SDK
项目 pom.xml 中添加 openai-code-review-sdk 依赖
### 2. 配置环境变量
在 github 或其他 CI/CD 工具中触发 openai-code-review-sdk 的执行，例如 .github/workflows/main-maven-jar.yml 中：
```yml
jobs:
  build:
    steps:
      - name: Run Java Jar
        run: java -jar ./libs/openai-code-review-sdk-1.0.0.jar
```