chore: README.md
This commit is contained in:
parent
9a9b154040
commit
43e8635e7f
|
@ -0,0 +1,26 @@
|
|||
# 指南
|
||||
|
||||
## Commit 指南
|
||||
|
||||
Commit messages 请遵循[conventional-changelog 标准](https://www.conventionalcommits.org/en/v1.0.0/):
|
||||
|
||||
```bash
|
||||
<类型>[可选 范围]: <描述>
|
||||
|
||||
[可选 正文]
|
||||
|
||||
[可选 脚注]
|
||||
```
|
||||
|
||||
### Commit 类型
|
||||
|
||||
以下是 commit 类型列表:
|
||||
|
||||
- feat: 新特性或功能
|
||||
- fix: 缺陷修复
|
||||
- docs: 文档更新
|
||||
- style: 代码风格或者组件样式更新
|
||||
- refactor: 代码重构,不引入新功能和缺陷修复
|
||||
- perf: 性能优化
|
||||
- test: 单元测试
|
||||
- chore: 其他不修改 src 或测试文件的提交
|
16
README.md
16
README.md
|
@ -4,14 +4,16 @@
|
|||
|
||||
![cover](./docs/cover-2.png)
|
||||
|
||||
## Route Map
|
||||
[x] 多会话
|
||||
## 待实现路线
|
||||
[x] 多会话储存和上下文逻辑
|
||||
|
||||
[x] 多语言
|
||||
[x] 对代码等消息类型的格式化美化处理
|
||||
|
||||
[x] 主题
|
||||
[x] 用户模块(注册、登录、个人中心)
|
||||
|
||||
[x] 用户模块
|
||||
[x] 界面多语言
|
||||
|
||||
[x] 界面主题
|
||||
|
||||
[x] More...
|
||||
|
||||
|
@ -89,6 +91,10 @@ pnpm build
|
|||
```
|
||||
|
||||
### 常见问题
|
||||
Q: 为什么 `Git` 提交总是报错?
|
||||
|
||||
A: 因为有提交信息验证,请遵循 [Commit 指南](./CONTRIBUTING.md)
|
||||
|
||||
Q: 如果只使用前端页面,在哪里改请求接口?
|
||||
|
||||
A: 根目录下 `.env` 文件中的 `VITE_GLOB_API_URL` 字段。
|
||||
|
|
Loading…
Reference in New Issue