@zhnyfe/zhnyfe_xnom 0.0.0-alpha.1

package/README.md

@@ -0,0 +1,26 @@
+# xnsk_fe_xnom 先农数科前端团队openlayers功能相关的SDK
+
+## 项目初始化
+
+- node 版本 v14.21.3
+
+## 项目搭建与运行
+```bash
+# 安装依赖
+$ yarn install
+
+# 运行项目（开发）
+$ yarn serve
+
+# 编译部署
+$ yarn build
+
+# eslint
+$ yarn lint
+```
+
+
+## 提交修改
+项目的**changelog**是基于**commit message**生成，```git commit```时message信息需要遵循[Angular规范](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.greljkmo14y0)，项目内置了[commitlint](https://github.com/conventional-changelog/commitlint)会在每次进行git commit时对message信息进行校验，格式不符合规范将中止提交。
+推荐全局安装[commitizen](https://github.com/conventional-changelog/commitlint)来快速创建符合规范的commit message
+如果使用vscode进行开发，强烈推荐安装[commitizen插件](https://marketplace.visualstudio.com/items?itemName=KnisterPeter.vscode-commitizen)