主包: pages
- home: 首页
- login: "登录"页
- message: "消息"页
- mine: "我的"页
分包1: auth-flow(登录认证)
- wechat-auth: 微信授权页
- forget-password: 忘记密码页
- reset-password: 重置密码页
- bind-email: 绑定邮箱页
分包2: discover(发现模块及其子页)
- search: 搜索页
- search-result: 搜索结果页
分包3: chat(消息模块及其子页)
- detail: 聊天详情页
分包4: mine-config(我的&设置模块及其子页)
- edit-profile: 编辑资料页
- setting: 设置页
- account-safe: 账号与安全页
- has-password: 修改密码页

目录结构

事实上，关注⭐️标注的文件夹即可


/项目根目录
├── auth-flow/                  # ⭐️【分包1】：登录认证流程
│   ├── bind-email/             # 绑定邮箱页
│   ├── forget-password/        # 忘记密码页
│   ├── reset-password/         # 重置密码页
│   └── wechat-auth/            # 微信授权页
│
├── chat/                       # ⭐️【分包3】：消息模块子页
│   └── detail/                 # 聊天详情页
│
├── common/                     # 公共工具与配置
│   └── config.js               # 全局配置文件
│
├── components/                 # ⭐️ 全局公共组件
│   └── my-tabbar/              # 自定义 TabBar 组件
│
├── discover/                   # ⭐️【分包2】：发现模块子页
│   ├── search/                 # 搜索页
│   └── search-result/          # 搜索结果页
│
├── mine-config/                # ⭐️【分包4】：我的/设置子页
│   ├── account-safe/           # 账号与安全页
│   ├── edit-profile/           # 编辑资料页
│   ├── has-password/           # 修改密码页
│   └── setting/                # 设置页
│
├── pages/                      # ⭐️【主包】
│   ├── home/                   # 首页
│   ├── login/                  # 登录页
│   ├── message/                # 消息页
│   └── mine/                   # 我的页
│
├── static/                     # 静态资源（图片、字体、公共样式等）
│   ├── customicons.css         # 自定义图标样式
│   ├── customicons.ttf         # 自定义图标字体
│   └── ... (图片资源)
│
├── uni_modules/                # 插件与组件库
│   ├── uview-plus/             # uView Plus UI 库
│   └── ... (uni-ui 官方组件)
│
├── App.vue                     # 应用配置，用来配置App全局样式以及监听
├── main.js                     # Vue初始化入口文件
├── manifest.json               # 配置应用名称、appid、logo、版本等打包信息
├── pages.json                  # ⭐️ 配置页面路由、导航条、选项卡等页面类信息(修改启动页)
├── uni.scss                    #/项目根目录

Git协作规范

`.gitignore`说明


# 忽略uni-app编译生成的unpackage目录(不然会导致大量编译产生的文件冲突，很混乱🥴)
unpackage/

如果你已经在Stage区，即`git add`了`unpackage/`的内容，如何撤销？


git rm -r --cached unpackage/

PS: 该命令会将unpackage/目录从Git的版本控制中移除，但不会删除你本地的文件

开发规范

分支(Branch)

开发新功能/修复bug时，请务必新建分支(先在本地新建，再push到远程即可同步)，分支命名格式统一为: feat/... or fix/...

Sync Frequently原则: 请经常pull远程main分支的最新代码，再切换会开发分支，并merge最新的main分支代码，以尽早发现冲突。具体流程如下:


# 切换会main分支，并pull最新代码
git checkout main 
git pull origin main

# 切换回你的开发分支，并merge最新的main分支代码
git checkout feat/...  # or fix/...

# 合并main分支最新代码到当前分支，并尽早处理冲突
git merge main

提交(Commit)

无论是在自己的开发分支，还是在主分支上提交时，都建议遵守以下规范:

采用<type>(<scope>): <subject>的格式: 如feat(home): 增加调用获取推荐标签API功能
- <type>(must-have): 提交类型
  - feat: 新功能🚀，表示新主题、新页面或新组件；新增调用...API功能
  - style: 对页面样式的调整和修改
  - fix: 修复bug
  - docs: 文档更新(如修改README.md)
  - refactor: 重构代码(不是新增功能，也不是修改 bug 的代码变动)
  - test: 添加测试
- <scope>(optional): 表示此次commit的修改范围(常在提交到main分支时使用，如feat(home)表示新增首页相关的功能)
- <subject>(must-have): 简短描述此次提交的内容，使用祈使句

代码(Code)

凡是uView-plus有的组件，都优先使用 → 如<u-button>✅，而不是<button>
优先使用rpx(Responsive Pixel)作为单位✅，以适配不同手机屏幕；尽量不用px单位
文件夹📂、文件📃、组件命名统一使用小写字母，用“-”分隔，不使用下划线 → 如search-result.vue

提交前检查(Pre-commit & Merge Check)

将开发分支合并到main分支后，记得先修改pages.json中的启动页，再git add pages.json，最后再提交

日常开发: 在你个人的开发分支上，每完成一个部分，就可以提交一次


git add . # 添加所有修改的文件到暂存区
git commit -m "feat(scope): (subject)" # 提交，scope可选
git push origin feat/... # 推送到对应的远程开发分支

完成feat/...分支的开发后，准备合并到main分支: (采用Squash Merge)


# 首先确保本地main分支是最新的
git checkout main
git pull origin main # 拉取远程main分支的最新代码，若有冲突，此处应先解决

# 在主分支处: 将开发分支合并到主分支
git merge --squash feat/... # 使用squash合并，将开发分支新的所有提交压缩为一次提交说明

git status # (optional)查看状态以验证

# 若有冲突，请手动合并解决冲突(或修改启动页后)，再`git add <file>`
git commit -m "feat(scope): (subject)" # 描述squash合并的所有提交的内容

# 推送到远程main分支
git push origin main