@zykj2024/much-library 1.1.7-beta.3 → 1.1.7-beta.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,35 @@
+# much-library
+
+基于 ant-design 和 web 端一体化设计标准 实现的 React 组件库，旨在提高 B 端平台开发效率以及通用组件标准化。
+
+## 主要目录
+
+- /src 组件开发目录
+- /script 组件构建脚本目录
+- /docs 文档目录
+
+## 开发流程
+
+- 从 `main` 分支拉取组件分支 `feature/*`，例如：McInput 组件分支`feature/tree_panel`，若多人维护则增加个人标识`feature/tree_panel-csy`
+- 在 /src 中新建对应组件目录，书写组件.tsx 以及 文档.md，可执行 `npm run dev` 在文档 demo 上直接调试
+- css 采用约定命名规则，使用 less 语法，遵守 BEM 规范，给组件一个外层类名 `.mc-*`
+- /src/index.ts 导入组件，组件库支持按需引入
+- 更新 `log.md` 文件
+- 本地开发完毕后执行`npm run doctor` 校验，校验通过后可提交`develop`分支 MR，指向对应同学进行 Review 合并
+
+## 发布流程
+
+- npm 包发布，更新 version 版本号，执行`npm publish`即可。[much-library](https://www.npmjs.com/package/much-library)
+- docs 发布，执行`npm run docs:build`，通过 ssh 部署 docs-dist。[much-docs](http://frontend.yunxiacn.com/much-docs/)
+- 相关账号配置联系 @陈书妍（一匠）
+
+## 问题反馈
+
+- 使用过程中有任何问题，可到对应仓库提交 [issue](http://gitlab.yunxiacn.com/data-group-front/much-library/-/issues)
+- 需添加使用场景，是否必现，复现路径等细节
+- 紧急情况下，可以自行进行实行，提交 MR 即可
+
+## 关联资源
+
+- [web 端一体化设计](https://mastergo.com/file/124592686063679?fileOpenFrom=project&page_id=116%3A9034) @张乐（卡卡）
+- [dumi 组件框架](https://d.umijs.org/)