View-UI 组件库开发指南

欢迎来到 View-UI 组件库的开发环境！本项目旨在创建一套高效且易用的 UI 组件集合。以下是针对开发者的工作流程和规范。

项目结构概览

• components/: 包含所有组件的源代码。

  • 每个组件（如 VTransfer）都有一个对应的文件夹，其中包含实现组件功能的 index.vue 文件。
  • 测试: 使用 test.vue 文件来验证组件的功能是否正常工作。这些测试页面可以直接在浏览器中打开以检查组件的行为。

• views/: 包含应用的具体页面视图。

  • 开发者可以在 views/ 目录下添加自己的 .vue 文件作为开发页面，用于集成和测试组件。
  • 引入 components 中的 test.vue 文件来进行组件的功能测试。

• router/: 配置路由规则的地方。

  • 新增开发人员时，请在此处配置个人的路由。

• app.vue: 应用的入口文件，确保新添加的路由属性被正确引用。

组件开发流程

1. 在 components 文件夹内进行组件开发。
2. 使用 index.vue 文件定义组件的所有功能。
3. 创建 test.vue 文件用于测试组件的功能，注意组件是否需要回显。
4. 数据应直接在 test.vue 或 index.vue 中写死，现阶段不涉及接口调用。

添加新开发人员

当有新的开发人员加入项目时，请按照以下步骤操作：

1. 在 router 中配置个人的路由。
2. 在 views 文件夹中增加个人的开发页面。
3. 在 app.vue 中添加相应的路由属性。

Git 提交规范

请确保所有的 Git 提交都遵循以下提交信息格式规范。

类型	说明
feat	增加新功能
fix	修复问题/BUG
style	代码格式/风格调整
perf	优化性能
refactor	重构代码
test	添加或修改测试代码
docs	文档/注释修改
chore	依赖更新/配置修改
ci	持续集成相关修改
types	类型定义文件调整
wip	开发中

文档预览与开发

为了方便开发者查看和编辑文档，我们提供了本地文档服务。你可以通过运行以下命令来启动文档服务器并实时预览文档：

pnpm docs:dev

这将会启动一个本地服务器，使你可以在浏览器中预览组件库的开发指南。任何对文档的更改都会自动刷新页面，以便立即看到效果。

你也可以直接访问https://viewstarts.github.io/View-ui/ ,来在线查看组件库的开发指南。

重要提示

• 项目的更改请在 dev 分支上进行。

请拉取代码以后，转到dev分支上撰写你的代码，main分支上的代码，每周末项目管理者会手动进行合并。

后续更新

本指南将持续更新，以适应项目的成长和发展。如果有任何疑问或建议，请随时联系项目管理员。

---