GithubBackup/PicList
1
0
Fork 0
mirror of https://github.com/Kuingsmile/PicList.git synced 2026-09-05 23:47:43 +08:00
Code Issues Packages Projects Releases Wiki Activity

📝 Docs(custom): update comtributing guide

Browse Source
This commit is contained in:
Kuingsmile
2025-08-14 16:35:29 +08:00
parent bb881fa966
commit 5738a9f834
2 changed files with 18 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING_EN.md
+9 -5
View File
@@ -2,6 +2,11 @@
## Installation and startup
Minimum requirements:
- Node.js >= 20
- Yarn >= 1.22
1. Use [yarn](https://yarnpkg.com/) to install dependencies
```bash
@@ -16,12 +21,11 @@ yarn dev
Startup project.
1. Please add code only related to the main process of Electron in the `src/main` directory. Code only related to the rendering process should be added in the `src/renderer` directory. Add code that can be used by both processes in the `src/universal` directory.
2. Please add all cross-process event names in `src/universal/events/constants.ts`.
3. Please add all global type definitions in `src/universal/types/`, if it is `enum`, please add it in `src/universal/types/enum.ts`.
4. Code related to the management function of the picture bed should be added in the `src/main/manage` and `src/renderer/manage` directory.
1. Please add code only related to the main process of Electron in the `src/main` directory. Code only related to the rendering process should be added in the `src/renderer` directory. Add code that needs to be exposed to the rendering process in the `src/preload` directory.
2. Please add all global type definitions in `src/universal/types/`, if it is `enum`, please add it in `src/universal/types/enum.ts`.
3. Code related to the management function of the picture bed should be added in the `src/main/manage` and `src/renderer/manage` directory.
## i18n
## i18n-Main Process
1. Create a language `yml` file under `public/i18n/`, for example `zh-Hans.yml`. Then refer to `zh-CN.yml` or `en.yml` to write language files. Also note that PicList will display the name of the language to the user via `LANG_DISPLAY_LABEL` in the language file.
2. Add a default language to `src/universal/i18n/index.ts`. where `label` is the value of `LANG_DISPLAY_LABEL` in the language file, and `value` is the name of the language file.