The repository of quick-issue
| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
| 3 年前 | ||
| 1 年前 | ||
| 4 个月前 | ||
| 4 个月前 | ||
| 1 个月前 | ||
| 1 年前 | ||
| 2 年前 | ||
| 4 个月前 | ||
| 1 年前 | ||
| 3 年前 | ||
| 7 个月前 | ||
| 3 年前 | ||
| 3 年前 | ||
| 6 个月前 | ||
| 4 个月前 | ||
| 3 年前 | ||
| 4 天前 | ||
| 4 天前 | ||
| 6 个月前 | ||
| 3 年前 | ||
| 11 个月前 | ||
| 1 年前 |
quick-issue
介绍
The repository of quick-issue
软件架构
软件架构说明
app
├─ .vitepress
├─ public // 静态资源文件，不参与打包编译
├─ src // 业务
├─ api // 接口
├─ assets // 资源文件
├─ components // 组件
├─ i18 // 国际化
├─ shared // 公用方法/样式
├─ stores // 状态管理
├─ views // 业务vue文件
├─ en // 英文页面
├─ ru // 俄文页面
├─ zh // 中文页面
- xxxx
- xxxx
- xxxx
使用说明
- xxxx
- xxxx
- xxxx
参与贡献
命名
命名形式
camelCase: 驼峰式kebab-case: 短横线连接式PascalCase: 帕斯卡命名式Snake: 下划线连接式
说明
- 文件夹以及文件命名(除 Vue SFC)采用
kebab-case - Vue SFC 文件命名使用
PascalCase, 在该文件中使用的 Vue 组件也使用PascalCase - Vue 组件中
emit事件使用kebab-case - 变量以及方法命名使用
camelCase, 资源文件使用Snake表明 light/dark, zh/en/ru，，eg: homeBanner_light_zh, 其中风格在前，语言在后 - CSS 使用
kebab-case命名 - Icon 组件引入时增加 Icon 前缀，eg:
import IconDownload from '~icons/app/download'
开发规范
- 所有接口类方法请写在
app/.vitepress/src/api中，并按照jsdoc 注释规范给出注释，不同模块接口请按文件进行区分, eg:api-cve.ts - 公共 utils 方法请按jsdoc 注释规范给出注释
- 变量命名做到见名知义，方法命名使用动词或动宾结构, eg:
import warningImg from '@/assets/icons/warning.png,const getUserEmail=()=>{} - 调用接口获取数据请使用
try {} catch(error) {}进行校验 - 约束
for...in的使用, 可以使用Object.keys().forEach - 使用
prettier插件作为格式化工具 - 提交之前请先进行 eslint 检查： 执行脚本，运行
pnpm lint。确认无问题后提交。项目工程的git hooks 已配置相关校验，如git commit不成功，请查看相关错误信息，并进行修改 git commit信息请尽量参照相关规范- 其他注意事项请参考业界相关通用开发规范说明