mirror of
https://github.com/hustcer/deepseek-review.git
synced 2026-05-13 05:16:05 +08:00
doc: Reorganize docs
This commit is contained in:
hustcer
108
README.zh-CN.md
108
README.zh-CN.md
@@ -10,63 +10,10 @@
|
||||
|
||||
## 计划支持特性
|
||||
|
||||
- [ ] **通过提及触发代码审查**：当 PR 评论中提及 `github-actions bot` 时，自动触发代码审查
|
||||
- [ ] **通过提交信息跳过代码审查**：在提交信息中添加 `skip cr` 或 `skip review` 以跳过该 PR 的代码审查
|
||||
- [ ] **通过提及触发代码审查**：当 PR 评论中提及 `github-actions bot` 时，自动触发代码审查
|
||||
- [ ] **忽略指定文件变更**：忽略对指定文件的更改，例如 `Cargo.lock`、`pnpm-lock.yaml` 等
|
||||
|
||||
## 本地代码审核
|
||||
|
||||
### 依赖工具
|
||||
|
||||
在本地进行代码审核需要安装以下工具：
|
||||
|
||||
- [`Nushell`](https://www.nushell.sh/book/installation.html) & [`Just`](https://just.systems/man/en/packages.html), 建议安装最新版本
|
||||
- 如果你需要在本地审核 GitHub PRs 还需要安装 [`gh`](https://cli.github.com/)
|
||||
- 接下来只需要把本仓库代码克隆到本地，然后进入仓库目录执行 `just code-review -h` 或者 `just cr -h` 即可看到类似如下输出:
|
||||
|
||||
```console
|
||||
Use Deepseek AI to review code changes
|
||||
|
||||
Usage:
|
||||
> deepseek-review {flags} (token)
|
||||
|
||||
Flags:
|
||||
-d, --debug: Debug mode
|
||||
-r, --repo <string>: GitHub repository name, e.g. hustcer/deepseek-review
|
||||
-n, --pr-number <string>: GitHub PR number
|
||||
--gh-token <string>: Your GitHub token, GITHUB_TOKEN by default
|
||||
-t, --diff-to <string>: Diff to git REF
|
||||
-f, --diff-from <string>: Diff from git REF
|
||||
-m, --model <string>: Model name, deepseek-chat by default (default: 'deepseek-chat')
|
||||
--base-url <string> (default: 'https://api.deepseek.com')
|
||||
-s, --sys-prompt <string> (default: 'You are a professional code review assistant responsible for analyzing code changes in GitHub Pull Requests. Identify potential issues such as code style violations, logical errors, security vulnerabilities, and provide improvement suggestions. Clearly list the problems and recommendations in a concise manner.')
|
||||
-u, --user-prompt <string> (default: 'Please review the following code changes:')
|
||||
-h, --help: Display the help message for this command
|
||||
|
||||
Parameters:
|
||||
token <string>: Your Deepseek API token, fallback to DEEPSEEK_TOKEN (optional)
|
||||
|
||||
```
|
||||
|
||||
### 环境配置
|
||||
|
||||
在本地进行代码审核需要先修改配置文件，仓库里已经有了 `.env.example` 配置文件示例，将其拷贝到 `.env` 然后根据自己的实际情况进行修改即可。
|
||||
|
||||
### 使用举例
|
||||
|
||||
```sh
|
||||
# 对本地 DEFAULT_LOCAL_REPO 仓库 `git diff` 修改内容进行代码审核
|
||||
just cr
|
||||
# 对本地 DEFAULT_LOCAL_REPO 仓库 `git diff f536acc` 修改内容进行代码审核
|
||||
just cr --diff-from f536acc
|
||||
# 对本地 DEFAULT_LOCAL_REPO 仓库 `git diff f536acc 0dd0eb5` 修改内容进行代码审核
|
||||
just cr --diff-from f536acc --diff-to 0dd0eb5
|
||||
# 对远程 DEFAULT_GITHUB_REPO 仓库编号为 31 的 PR 进行代码审核
|
||||
just cr --pr-number 31
|
||||
# 对远程 hustcer/deepseek-review 仓库编号为 31 的 PR 进行代码审核
|
||||
just cr --pr-number 31 --repo hustcer/deepseek-review
|
||||
```
|
||||
|
||||
## 通过 GitHub Action 进行代码审核
|
||||
|
||||
```yaml
|
||||
@@ -120,6 +67,59 @@ Deepseek 接口调用入参:
|
||||
}
|
||||
```
|
||||
|
||||
## 本地代码审核
|
||||
|
||||
### 依赖工具
|
||||
|
||||
在本地进行代码审核需要安装以下工具：
|
||||
|
||||
- [`Nushell`](https://www.nushell.sh/book/installation.html) & [`Just`](https://just.systems/man/en/packages.html), 建议安装最新版本
|
||||
- 如果你需要在本地审核 GitHub PRs 还需要安装 [`gh`](https://cli.github.com/)
|
||||
- 接下来只需要把本仓库代码克隆到本地，然后进入仓库目录执行 `just code-review -h` 或者 `just cr -h` 即可看到类似如下输出:
|
||||
|
||||
```console
|
||||
Use Deepseek AI to review code changes
|
||||
|
||||
Usage:
|
||||
> deepseek-review {flags} (token)
|
||||
|
||||
Flags:
|
||||
-d, --debug: Debug mode
|
||||
-r, --repo <string>: GitHub repository name, e.g. hustcer/deepseek-review
|
||||
-n, --pr-number <string>: GitHub PR number
|
||||
--gh-token <string>: Your GitHub token, GITHUB_TOKEN by default
|
||||
-t, --diff-to <string>: Diff to git REF
|
||||
-f, --diff-from <string>: Diff from git REF
|
||||
-m, --model <string>: Model name, deepseek-chat by default (default: 'deepseek-chat')
|
||||
--base-url <string> (default: 'https://api.deepseek.com')
|
||||
-s, --sys-prompt <string> (default: 'You are a professional code review assistant responsible for analyzing code changes in GitHub Pull Requests. Identify potential issues such as code style violations, logical errors, security vulnerabilities, and provide improvement suggestions. Clearly list the problems and recommendations in a concise manner.')
|
||||
-u, --user-prompt <string> (default: 'Please review the following code changes:')
|
||||
-h, --help: Display the help message for this command
|
||||
|
||||
Parameters:
|
||||
token <string>: Your Deepseek API token, fallback to DEEPSEEK_TOKEN (optional)
|
||||
|
||||
```
|
||||
|
||||
### 环境配置
|
||||
|
||||
在本地进行代码审核需要先修改配置文件，仓库里已经有了 `.env.example` 配置文件示例，将其拷贝到 `.env` 然后根据自己的实际情况进行修改即可。
|
||||
|
||||
### 使用举例
|
||||
|
||||
```sh
|
||||
# 对本地 DEFAULT_LOCAL_REPO 仓库 `git diff` 修改内容进行代码审核
|
||||
just cr
|
||||
# 对本地 DEFAULT_LOCAL_REPO 仓库 `git diff f536acc` 修改内容进行代码审核
|
||||
just cr --diff-from f536acc
|
||||
# 对本地 DEFAULT_LOCAL_REPO 仓库 `git diff f536acc 0dd0eb5` 修改内容进行代码审核
|
||||
just cr --diff-from f536acc --diff-to 0dd0eb5
|
||||
# 对远程 DEFAULT_GITHUB_REPO 仓库编号为 31 的 PR 进行代码审核
|
||||
just cr --pr-number 31
|
||||
# 对远程 hustcer/deepseek-review 仓库编号为 31 的 PR 进行代码审核
|
||||
just cr --pr-number 31 --repo hustcer/deepseek-review
|
||||
```
|
||||
|
||||
## 许可
|
||||
|
||||
Licensed under:
|
||||
|
||||
Reference in New Issue
Block a user