docs: 贡献指南

2024-11-30 02:37:52 +08:00 · 2022-06-27 11:20:15 +08:00 · 2022-06-27 11:20:15 +08:00 · 223f38be79
commit 223f38be79
parent e426de9810
2 changed files with 82 additions and 39 deletions
--- a/docs/.vuepress/config.ts
+++ b/docs/.vuepress/config.ts
@ -28,7 +28,7 @@ const config: UserConfig<DefaultThemeOptions> = {

    docsDir: 'docs',

-    docsBranch: 'vue3',
+    docsBranch: 'master',

    // theme-level locales config
    locales: {
--- a/docs/guide/contributing.md
+++ b/docs/guide/contributing.md
@ -1,13 +1,11 @@
 # 贡献指南

-## 概览
+## 包概览

-项目仓库借助于 [Yarn Classic 工作区](https://classic.yarnpkg.com/zh-Hans/docs/workspaces) 来实现 [Monorepo](https://en.wikipedia.org/wiki/Monorepo) ，在 `packages` 目录下存放了多个互相关联的独立 Package 。
+项目仓库借助于 [Yarn 工作区](https://classic.yarnpkg.com/zh-Hans/docs/workspaces) 来实现 [ Monorepo](https://en.wikipedia.org/wiki/Monorepo) ，在 `packages` 目录下存放多个互相关联的独立包。

 - `@fesjs/create-fes-app`: 创建项目模板模块。提供`create-fes-app`命令，提供创建多种类型项目模板的能力。
  
- `@fesjs/fes`: 入口模块。提供`fes`命令和 API 入口。 
-
 - `@fesjs/compiler`: 编译时插件管理模块。定义插件的生命周期、插件配置、插件通讯机制等。

 - `@fesjs/runtime`: 运行时插件模块。集成了vue-router，定义运行时插件生命周期、插件通讯机制。
@ -20,51 +18,96 @@

 - `@fesjs/plugin-${name}`: 官方插件。

- `@fesjs/fes`: 是 `@fesjs/compiler` + `@fesjs/runtime` + `@fesjs/preset-build-in` 的封装。用户只需要安装此依赖和额外的插件或者插件集。
+- `@fesjs/fes`: 入口模块。提供`fes`命令和 API 入口，封装`@fesjs/compiler` + `@fesjs/runtime` + `@fesjs/preset-build-in`，用户只需要安装此依赖和其他插件。

-## 开发配置
+
+## 开发准备

 开发要求：

- [Node.js](http://nodejs.org) **version 12+**
- [Yarn v1 classic](https://classic.yarnpkg.com/zh-Hans/docs/install)
-
-克隆代码仓库，并安装依赖：
-
-```bash
-yarn
-```
-
-监听源文件修改：
-
-```bash
-yarn build
-```
-
-打开另一个终端，开始开发项目文档网站：
-
-```bash
-yarn docs:dev
-```
+- [Node.js v14+](http://nodejs.org) 
+- [Yarn v1](https://classic.yarnpkg.com/zh-Hans/docs/install)

 本项目开发使用的一些主要工具：

 - [Jest](https://jestjs.io/) 用于单元测试
 - [ESLint](https://eslint.org/) + [Prettier](https://prettier.io/) 用于代码检查和格式化
- [@umi/father](https://github.com/umijs/father) 用于将ES6语法编译成ES5或者CommonJS

-## 开发脚本
+克隆仓库：

-### `yarn build`
+```bash
+git clone https://github.com/WeBankFinTech/fes.js.git
+```

-`build` 命令会使用 `father-build` 将 ES6 编译为 CommonJS。
+进入`fes.js`目录，安装依赖：

-本项目在编写Node端的代码时也用ES6，所以你在克隆代码仓库后，可能需要先执行该命令来确保项目代码可以顺利运行，因为编译后的 JS 文件被 `.gitignore` 排除在仓库以外了。
-### `yarn docs:dev`
-`docs:` 前缀表明，这些命令是针对文档 (documentation) 进行操作的，即 `docs` 目录。      
-使用 Vue Press在本地启动文档网站服务器，用于实时查看文档效果。
+```bash
+yarn
+```

-### 调试功能
-在开发完插件代码后，需要在template项目中验证功能
- 进入`packages/template`目录
- 执行`yarn dev`
+## 贡献文档
+文档代码在`docs`目录，基于 [vuepress](https://v2.vuepress.vuejs.org/zh/) 实现。
+
+#### 第一步：启动服务
+
+```bash
+yarn docs:dev
+```
+
+#### 第二步：修改md文件
+菜单配置在`/docs/.vuepress/configs/sidebar/zh.ts`中，可以通过此配置找到对应想修改的文档。       
+
+如果想添加图片，则可以先把图片添加至`/docs/.vuepress/public`，在代码中使用：
+```html
+<img :src="$withBase('framework.png')" alt="架构">
+```
+
+#### 第三步：查看更新
+当md文档保存后，文档会自动更新，在`http://localhost:8080/`查看。
+
+
+
+## 贡献源码
+`Fes.js`统一使用`ES Module`规范编写源码，代码会在 node 端和浏览器端执行，所以源码需要编译后才能发布成包，再被执行。
+
+#### 启动编译服务
+
+```bash
+yarn dev
+```
+
+当我们修改`build.config.js`中配置的包代码时，会把`src`目录的源码编译后到`lib`目录。
+
+#### 修改源码
+在了解`Fes.js`设计前提下，修改核心代码或者插件代码。
+
+#### 验证修改内容
+
+根据需求选择模板项目，比如选择`fes-template`，查看需验证的包是否已经添加到模板项目，如果没有：
+1. 在package.json中添加包依赖
+2. 在根目录执行`yarn`安装依赖
+3. 启动服务
+```bash
+cd packages/fes-template
+yarn dev
+```
+4. 在项目模板中添加代码验证修改内容
+5. 打开`localhost:8000`查看结果
+
+#### 快速调试技巧
+每次修改插件或者核心代码后，需要重新在模板目录执行`fes dev`，再编写测试代码验证功能，比较费时费力。
+
+可以先在模板的 `.fes` 目录中找到对应临时代码，更改逻辑，验证完后再将变更逻辑保存到正式文件中。
+
+:::warning
+直接修改临时文件切莫重新执行`fes dev`，修改会被覆盖。
+:::
+
+
+## 提交PR
+
+1. fork项目!
+2. 创建你的功能分支: git checkout -b my-new-feature
+3. 本地提交新代码: git commit -am 'Add some feature'
+4. 推送本地到服务器分支: git push origin my-new-feature
+5. 创建一个PR