Skip to content

Commit 0424778

Browse files
author
xin.xu1
committed
update readme
1 parent 28eee07 commit 0424778

File tree

5 files changed

+68
-22
lines changed

5 files changed

+68
-22
lines changed

Dockerfile

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
FROM python:3.9-slim
2+
3+
RUN apt-get update && apt-get install -y gcc libffi-dev python3-dev
4+
5+
WORKDIR /workspace
6+
7+
COPY . .
8+
9+
RUN pip install --no-cache-dir -r requirements.txt
10+
11+
ENV PYTHONPATH=/workspace
12+
13+
CMD ["python", "app.py"]
14+
15+

README.md

Lines changed: 53 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,28 @@
2121

2222
# 项目描述 📚
2323

24-
> 一个利用大模型帮助我们在 Gitlab 上进行 Code Review 提升研发效能的项目 💪🏻 (( 包括但不限于 GPT 🎁))
24+
> 一个利用大模型帮助我们在 Gitlab 上进行 Code Review 提升研发效能的项目 💪🏻 (( 包括但不限于 GPT 、DeepSeek 等🎁))
2525
2626
**这个项目有什么特点? ✨**
2727

28-
🐶 针对于 <span style="background-image: linear-gradient(to right, #ff9900, #ff66cc);-webkit-background-clip: text;color: transparent;font-weight: bold;">Gitlab 定制</span>
28+
🐶 针对于 **<span style="background-image: linear-gradient(to right, #ff9900, #ff66cc);-webkit-background-clip: text;color: transparent;font-weight: bold;"> Gitlab </span>** 定制 (计划支持 Github 、Gitlab 、Gitee 、Bitbucket 等)
2929

30-
🐱 结合了<span style="background-image: linear-gradient(to right, #ff9900, #ff66cc);-webkit-background-clip: text;color: transparent;font-weight: bold;">GPT</span>的能力 🚀
30+
🤖 我们正在开发 **<span style="background-image: linear-gradient(to right, #ff9900, #ff66cc);-webkit-background-clip: text;color: transparent;font-weight: bold;"> Multi-Agent </span>** 的插件,多个 **<span style="background-image: linear-gradient(to right, #ff9900, #ff66cc);-webkit-background-clip: text;color: transparent;font-weight: bold;"> Agent </span>** 协同工作,共同完成评审
31+
32+
🐱 结合了 **<span style="background-image: linear-gradient(to right, #ff9900, #ff66cc);-webkit-background-clip: text;color: transparent;font-weight: bold;"> 多种大模型对接 </span>** 的能力 🚀
33+
34+
🦊 能够接入私有化 LLM **<span style="background-image: linear-gradient(to right, #ff9900, #ff66cc);-webkit-background-clip: text;color: transparent;font-weight: bold;"> 代码安全问题 </span>**
35+
36+
🦁 我们将一直关注效能研发 **<span style="background-image: linear-gradient(to right, #ff9900, #ff66cc);-webkit-background-clip: text;color: transparent;font-weight: bold;"> 最新的Coder Review动态 </span>** 融入这个项目
3137

32-
🦊 能够接入私有化 LLM <span style="background-image: linear-gradient(to right, #ff9900, #ff66cc);-webkit-background-clip: text;color: transparent;font-weight: bold;">代码安全问题</span>
3338

34-
🦁 我们将一直关注效能研发 <span style="background-image: linear-gradient(to right, #ff9900, #ff66cc);-webkit-background-clip: text;color: transparent;font-weight: bold;">最新的Coder Review动态</span> 融入这个项目
3539

3640

3741
# 项目架构 🚗
42+
### 前期架构
43+
<p align="center">
44+
<img src="doc/img/old-architecture.png" style="width:500px;"/>
45+
</p>
3846

3947
### 🚀 **全新架构升级:更强大、更灵活、更高效!** 🌈
4048

@@ -77,7 +85,7 @@
7785

7886
<table style="width:100%; text-align:center; border-collapse:collapse;">
7987
<tr>
80-
<td>OpenAI</td>
88+
<td style="color:rgb(0, 64, 255); font-weight: bold;">OpenAI 🔥</td>
8189
<td>Azure</td>
8290
<td>AWS - SageMaker</td>
8391
<td>AWS - Bedrock</td>
@@ -130,7 +138,7 @@
130138
<td>月之暗面 Moonshot</td>
131139
<td>百度文心一言</td>
132140
</tr>
133-
<tr>
141+
<trd
134142
<td>阿里巴巴通义千问</td>
135143
<td>MiniMax</td>
136144
<td>讯飞星火</td>
@@ -143,7 +151,7 @@
143151
<td>字节豆包</td>
144152
</tr>
145153
<tr>
146-
<td>深度求索 DeepSeek</td>
154+
<td style="color:rgb(0, 64, 255); font-weight: bold;">深度求索 DeepSeek 🔥</td>
147155
<td>More</td>
148156
<td></td>
149157
<td></td>
@@ -160,6 +168,12 @@
160168

161169
# 部署 📖
162170

171+
#### Docker 运行
172+
173+
```bash
174+
docker run -d -v ./config:/workspace/config -p 8080:80 --name codereview xuxin1/llmcodereview:latest
175+
```
176+
163177
#### 源代码运行 💻
164178
1.**克隆仓库**
165179
```bash
@@ -178,22 +192,18 @@ vim config/config.py
178192
```bash
179193
python3 app.py
180194
```
181-
5.**配置Gitlab webhook**
195+
#### **配置Gitlab webhook**
182196
> 填写```Webhook URL```时,请在域名后添加路径```/git/webhook```,例如:```http://example.com/git/webhook```
183197
<p align="center">
184198
<img src="doc/img/webhookconfig.png" style="width:300px;"/>
185199
</p>
186200
187-
6.**尝试发起一个 Merge Request 吧🎉**
201+
#### **尝试发起一个 Merge Request 吧🎉**
188202

189203

190204

191205

192-
#### Docker
193206

194-
```bash
195-
todo dockerfile
196-
```
197207

198208

199209
# 待办清单 📌
@@ -208,15 +218,16 @@ todo dockerfile
208218
- [ ] 兼容钉钉的消息通知
209219
- [ ] 结合静态代码分析来提供修改代码的风险等级
210220
- [ ] 通过pydantic实现大模型输出内容的格式化
221+
- ✅ 支持插件式自定义 Review 的问题
211222

212223
# 交流 👨‍👨‍👦‍👦
213-
👏🏻 很高兴你能向我们提出一些问题和修改建议(issue,pr), 欢迎 star 项目 ⭐️
224+
👏🏻 很高兴你能向我们提出一些问题和修改建议(Issue,PR), 欢迎 **star 项目 ⭐️**
214225

215-
📮 Emailmixuxin@163.com
226+
📮 *Email***mixuxin@163.com**
216227

217-
📱 wx: isxuxin
228+
📱 *wx***isxuxin**
218229

219-
👨‍👨‍👦‍👦 如果有任何使用问题,欢迎来这里交流 👋🏻
230+
👨‍👨‍👦‍👦 如果有任何使用问题,欢迎来这里交流(<span style="background-image: linear-gradient(to right, #ff9900, #ff66cc);-webkit-background-clip: text;color: transparent;font-weight: bold;">AI 研发效能领域</span>) 👋
220231
<p float="left">
221232
<img src="doc/img/wechat.jpg" width="400" />
222233
<img src="doc/img/xuxin.png" width="400" />
@@ -229,11 +240,31 @@ todo dockerfile
229240
- [(美团)代码变更风险可视化系统建设与实践](https://tech.meituan.com/2023/09/22/construction-and-practice-of-code-change-risk-visualization-system.html)
230241

231242

232-
# License 📑
233-
![github license](https://img.shields.io/github/license/mimo-x/Code-Review-GPT-Gitlab)
234-
**This project is licensed under the [MIT License](https://chat.openai.com/c/9be6b422-f10c-4379-b152-e756230d54f8#:~:text=%E7%9A%84%E5%AE%8C%E6%95%B4%E6%96%87%E6%9C%AC%EF%BC%9A-,MIT%20License,-%E4%BD%A0%E5%8F%AF%E4%BB%A5%E8%AE%BF%E9%97%AE).**
235-
236243

237244
## Star History
238245

239246
[![Star History Chart](https://api.star-history.com/svg?repos=mimo-x/Code-Review-GPT-Gitlab&type=Date)](https://star-history.com/#mimo-x/Code-Review-GPT-Gitlab&Date)
247+
248+
## Powered by [Mobvista - 汇量科技](https://www.mobvista.com)
249+
250+
<p align="center">
251+
<img src="doc/img/Logo-MV.png" style="width:500px;"/>
252+
</p>
253+
254+
> **本项目由 [Mobvista 汇量科技](https://www.mobvista.com) 的技术团队研发及发布。**
255+
256+
[**Mobvista 汇量科技**](https://www.mobvista.com) 是全球领先的开发者增长平台。我们为全球开发者和营销人员**提供完整的广告和分析工具套件**,包括用户**获取、变现、分析、创意自动化和智能媒体采买**等,能大幅提升广告营销ROI,有效帮助移动应用突破增长平台期。
257+
258+
259+
260+
> **This tool is developed by the engineering team at [**Mobvista**](https://www.mobvista.com).**
261+
262+
Mobvista is a leading mobile technology company that provides **a complete suite of advertising and analytics tools** for app developers and marketers seeking global growth. Offering a range of tailored solutions, such as **user acquisition, monetization, analytics, creative automation, and cross-channel media buying**, Mobvista enables mobile businesses to maximize their potential.
263+
264+
For more information, please visit our website: www.mobvista.com
265+
266+
267+
268+
# License 📑
269+
![github license](https://img.shields.io/github/license/mimo-x/Code-Review-GPT-Gitlab)
270+
**This project is licensed under the [MIT License](https://chat.openai.com/c/9be6b422-f10c-4379-b152-e756230d54f8#:~:text=%E7%9A%84%E5%AE%8C%E6%95%B4%E6%96%87%E6%9C%AC%EF%BC%9A-,MIT%20License,-%E4%BD%A0%E5%8F%AF%E4%BB%A5%E8%AE%BF%E9%97%AE).**

doc/img/Logo-MV.png

228 KB
Loading

doc/img/old-architecture.png

556 KB
Loading

doc/img/wechat.jpg

-2.56 KB
Loading

0 commit comments

Comments
 (0)