Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/advanced/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

Execute the translation command in the command line to generate the translated document `example-mono.pdf` and the bilingual document `example-dual.pdf` in the current working directory. Use Google as the default translation service. More support translation services can find [HERE](https://github.com/Byaidu/PDFMathTranslate/blob/main/docs/ADVANCED.md#services).

<img src="./../images/cmd_light.png" width="580px" alt="cmd"/>
<img src="./../images/cmd_light.svg" width="580px" alt="cmd"/>
<!-- TODO 把命令行图片换掉 主命令部分黑色不透明 参数部分 75 透 颜色参考 https://developer.apple.com/design/human-interface-guidelines/color#iOS-iPadOS-system-colors -->

In the following table, we list all advanced options for reference:
Expand Down Expand Up @@ -201,7 +201,7 @@ For example, if you want to enable a GUI window, you can use the following comma
PDF2ZH_GUI=TRUE pdf2zh
```

<img src="./../images/env_light.png" width="580px" alt="env"/>
<img src="./../images/ev_light.svg" width="580px" alt="env"/>

- User-Specified **Configuration File**

Expand Down
33 changes: 24 additions & 9 deletions docs/community/Contribution-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,31 +41,46 @@

## 基本要求

1. **工作流程**
<h4 id="sop">1. 工作流程</h4>

- 请在 `main` 主分支上创建 fork,并在 fork 的分支上进行开发。
- 提交 Pull Request (PR) 时,请对提交的内容进行详细说明。
- 如果 PR 没有通过自动化检查(提示 `checks failed` 和红色叉号标记),请查看相应的 `details` 并修改提交内容,确保新的 PR 可以通过自动化检查。

2. **开发和测试**

<h4 id="dev&test">2. 开发和测试</h4>

- 使用 `pip install -e .` 命令进行开发和测试。

3. **代码格式化**

<h4 id="format">3. 代码格式化</h4>

- 配置 `pre-commit` 工具,启用 `black` 和 `flake8` 进行代码格式化。

4. **依赖更新**

<h4 id="requpdate">4. 依赖更新</h4>

- 如果引入了新的依赖,请及时更新 `pyproject.toml` 文件中的依赖列表。

5. **文档更新**
- 如果添加了新的命令行选项,请同步更新对应文档。

6. **提交信息**
<h4 id="docupdate">5. 文档更新</h4>

- 如果添加了新的命令行选项,请同步更新多语言版本的 `README.md` 文件中的命令行选项列表。


<h4 id="commitmsg">6. 提交信息</h4>

- 使用 [语义化提交信息](https://www.conventionalcommits.org/zh-hans/v1.0.0/),例如:`feat(translator): add openai`。

7. **编码风格**

<h4 id="codestyle">7. 编码风格</h4>

- 请确保提交的代码符合基本的编码风格规范。
- 变量命名请使用下划线或驼峰命名法。

8. **文档排版**

<h4 id="doctypo">8. 文档排版</h4>

- `README.md` 文件的排版请遵循 [中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines)。
- 确保英文和中文文档始终保持最新状态,其它语言文档为可选更新。

Expand Down
Loading
Loading