Skip to content

CONTRIBUTING_EN.md

Latest commit

 

History

History
37 lines (21 loc) · 1.79 KB

CONTRIBUTING_EN.md

File metadata and controls

37 lines (21 loc) · 1.79 KB

Contribution Guidelines

Installation and startup

  1. Use yarn to install dependencies
yarn install

then pass

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. Note: The rendering process does not have the Node.js capability. All rendering processes need to use Node.js modules related code, please add events under src/main/events/picgoCoreIPC.ts for processing.

  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.

i18n

  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 PicGo 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.

  3. If you are updating an existing language file, be sure to run yarn gen-i18n after the update to ensure that the correct language definition file can be generated.

Submit code

  1. Please check that the code has no extra comments, console.log and other debugging code.
  2. Before submitting the code, please execute the command git add . && yarn cz to invoke PicGo's Code Submission Specification Tool. Submit code through this tool.