Jelajahi Sumber

Update document

dufu1991 3 tahun lalu
induk
melakukan
ea5e7a32e5

+ 1 - 1
doc/guide/contribution.md

@@ -37,7 +37,7 @@ npm run dev
 
 启动成功之后,可在浏览器中打开 `http://localhost:8888` 查看效果,请将浏览器的开发者工具切换为移动端模式。
 
-可对 `components/src` 目录下组件源码进行修改并实时查看修改效果。注意,VS Code 与 WebStorm 都支持在调用组件时直接跳转到组件源码。
+可对 `packages/stdf/components` 目录下组件源码进行修改并实时查看修改效果。注意,VS Code 与 WebStorm 都支持在调用组件时直接跳转到组件源码。
 
 如果不想本地开发,可以选择使用 StackBlitz 在线简单调试。直接打开 [STDF Demo](https://stackblitz.com/github/dufu1991/demo-stdf) 即可开始在线调试。
 

+ 1 - 1
doc/guide/contribution_en.md

@@ -37,7 +37,7 @@ npm run dev
 
 After the startup is successful, you can open `http://localhost:8888` in the browser to view the effect. Please switch the developer tools of the browser to the mobile mode.
 
-You can modify the component source code under the `components/src` directory and view the modification effect in real-time. Note that both VS Code and WebStorm support directly jumping to the component source code when calling the component.
+You can modify the component source code under the `packages/stdf/components` directory and view the modification effect in real-time. Note that both VS Code and WebStorm support directly jumping to the component source code when calling the component.
 
 If you don't want to develop locally, you can choose to use StackBlitz to debug online. Just open [STDF Demo](https://stackblitz.com/github/dufu1991/demo-stdf?startScript=dev_en) to start online debugging.
 

+ 6 - 2
doc/guide/internation.md

@@ -95,5 +95,9 @@ STDF 组件使用 Svelte 的 [Context](https://svelte.dev/docs#run-time-svelte-s
 
 基本步骤如下:
 
-1. 在 components/lang 文件夹中增加语言包。
-2. (可选)更新文档,在 doc/guide 文件夹更新 [internation.md](https://github.com/dufu1991/stdf/edit/main/doc/guide/internation.md) 和 [internation_en.md](https://github.com/dufu1991/stdf/edit/main/doc/guide/internation_en.md) 文件,请在语言列表中按照 lang 的字母顺序更新。
+- 请先 fork 一份 [STDF](https://github.com/dufu1991/stdf) 代码到自己的仓库,如果已经 fork 过,请同步主仓库的最新代码。
+- 克隆你的仓库至本地。
+- 在 packages/stdf/lang 文件夹中增加语言包。
+- (可选)更新文档,在 doc/guide 文件夹更新 [internation.md](https://github.com/dufu1991/stdf/edit/main/doc/guide/internation.md) 和 [internation_en.md](https://github.com/dufu1991/stdf/edit/main/doc/guide/internation_en.md) 文件,请在语言列表中按照 lang 的字母顺序更新。
+- 提交修改内容至你的仓库,然后提 Pull Request 到主仓库。
+- Pull Request 会在 Review 通过后被合并到主仓库,并发布新版本至 npm。

+ 6 - 2
doc/guide/internation_en.md

@@ -95,5 +95,9 @@ If you cannot find the language pack you need, you are welcome to create a new l
 
 The basic steps are as follows:
 
-1. Add the language pack in the `components/lang` folder.
-2. (Optional) Update the documentation. Update the [internation.md](https://github.com/dufu1991/stdf/edit/main/doc/guide/internation.md) and [internation_en.md](https://github.com/dufu1991/stdf/edit/main/doc/guide/internation_en.md) files in the `doc/guide` folder. Please update the language list in alphabetical order by `lang`.
+- Please fork the [STDF](https://github.com/dufu1991/stdf) code to your own repository. If you have already forked it, please sync the latest code from the main repository.
+- Clone your repository to your local machine.
+- Add language packs in the packages/stdf/lang folder.
+- (Optional) Update the documentation. Update the [internation.md](https://github.com/dufu1991/stdf/edit/main/doc/guide/internation.md) and [internation_en.md](https://github.com/dufu1991/stdf/edit/main/doc/guide/internation_en.md) files in the doc/guide folder. Please update them in alphabetical order according to the lang list.
+- Commit the modifications to your repository and then submit a Pull Request to the main repository.
+- Once the Pull Request is approved during the review process, it will be merged into the main repository and a new version will be released on npm.