课时-25.md

课时 25：开发指南

如果有小伙伴想要一起开发或者在本地试跑的话，可以按照下面的流程来进行开发。

风格

js/ts 采用 eslint 风格，css 使用 stylelint 风格，其他使用 prettier 风格。建议使用 vscode 编译器，项目内已经内置了 vscode 配置。另外为了方便开发，您可以安装 eslint、stylelint、prettier 插件，

目录结构

主要介绍了些开发会用到的目录

│──── docs                  # 所有文档在这里编写
│   └── 课时-n               # 添加课时
│──── src                   # 开发目录
│   │── assets              # 公共资源
│   │── style               # 样式
│   └── ...
│──── packages              # 插件目录
.
.

docs 文档规范

1. 首行必须以 ## 开头

## 课题 01：初探 webpack

2. 首段介绍项目目录，使用锚点跳转到指定位置

本章主要讲解

1. <a href="#1_1">webpack 基础配置</a>

...
...

### <a name="1_1">webpack 基础配置</a>

3. 尽量讲明配置原因及细节

src 开发

1. src 主要是实现配置 demo 的展示，尽量保障优美雅观大气，目录分明，清晰表明意图
2. main.js 是主入口
3. assets 公共资源
4. style 样式

packages 插件

所有插件都在 packages 目录下完成

插件编写

插件编写规范在第 23 课时

npm 发包

1. 开发者可以加我好友，申请在 @pkb/* 下申请发包权限，@pkb 开头的为官方插件
2. 如果在 @pkb 下发包，首次需要执行 npm publish --access=public
3. 使用 lerna 进行插件管理，执行 lerna publish 发包

提交代码

使用 npm run cz 执行提交代码，可以按照提示填写内容即可。

1. 代码提交时会自动检查代码提交 commit 是否符合规范
2. 检查 lint，执行 lint-staged，自动修复 lint --fix

readme 编写

本项目 reame 是自动生成的，执行脚本在 tools/create-readme，如果有想要修改 readme 可以自行看代码

贡献者名单

只要是提交过 commit 的任何代码都会被加入到名单内