mirror of
https://github.com/Kuingsmile/PicList.git
synced 2025-01-23 14:48:13 -05:00
38 lines
1.6 KiB
Markdown
38 lines
1.6 KiB
Markdown
## 贡献指南
|
||
|
||
### 安装与启动
|
||
|
||
1. 使用 [yarn](https://yarnpkg.com/) 安装依赖
|
||
|
||
```bash
|
||
yarn install
|
||
```
|
||
|
||
然后通过
|
||
|
||
```bash
|
||
yarn dev
|
||
```
|
||
|
||
启动项目。
|
||
|
||
2. 只跟 Electron 主进程相关的代码请在 `src/main` 目录下添加。只跟渲染进程相关的代码请在 `src/renderer` 目录下添加。两个进程都能使用的代码请在 `src/universal` 目录下添加。 **注意**：渲染进程没有 `Node.js` 能力，所有渲染进程需要用到 `Node.js` 模块相关的代码请在 `src/main/events/picgoCoreIPC.ts` 下添加事件进行处理。
|
||
|
||
3. 所有的跨进程事件名请在 `src/universal/events/constants.ts` 里添加。
|
||
|
||
4. 所有的全局类型定义请在 `src/universal/types/` 里添加，如果是 `enum`，请在 `src/universal/types/enum.ts` 里添加。
|
||
|
||
|
||
### i18n
|
||
|
||
1. 在 `public/i18n/` 下面创建一种语言的 `yml` 文件，例如 `zh-Hans.yml`。然后参考 `zh-CN.yml` 或者 `en.yml` 编写语言文件。并注意，PicGo 会通过语言文件中的 `LANG_DISPLAY_LABEL` 向用户展示该语言的名称。
|
||
|
||
2. 在 `src/universal/i18n/index.ts` 里添加一种默认语言。其中 `label` 就是语言文件中 `LANG_DISPLAY_LABEL` 的值，`value` 是语言文件名。
|
||
|
||
3. 如果是对已有语言文件进行更新，请在更新完，务必运行一遍 `yarn gen-i18n`，确保能生成正确的语言定义文件。
|
||
|
||
### 提交代码
|
||
|
||
1. 请检查代码没有多余的注释、`console.log` 等调试代码。
|
||
2. 提交代码前，请执行命令 `git add . && yarn cz`，唤起 PicGo 的[代码提交规范工具](https://github.com/PicGo/bump-version)。通过该工具提交代码。
|