Git Commit规范

Wed, 24 Sep 2025 00:00:00 +0000

基本介绍

在使用Git进行代码仓库管理的时候，我们不可避免需要提交Commit，即每次提交代码需要标注本次进行了哪些修改，方便让合作者快速阅览了解开发内容，提高合作效率。目前Angular规范是最广泛的Git Commit规范方法，本文参考下列文档，使用中文编写新手友好的实用教程。

规范内容

Commit信息格式

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

其中type(提交类型)和subject(简短描述)是必须项，scope(影响范围)是可选项第一行为Header(标题)，第二部分为Body(正文)，最后部分为Footer(脚注) 一般实际开发中主要遵循标题规范，即 type(scope): subject，示例如下

feat(第二课堂): 显示第二课堂学分
fix(第二课堂): 修复第二课堂学分显示问题
docs: Readme中增加新人环境配置教程
test: 教务系统API单元测试

Type (提交类型)

常用的Type类型如下：

feat: 新功能
fix: 修复 bug
docs: 文档修改
style: 不影响代码逻辑的格式调整
refactor: 既不是新功能也不是修复 bug 的代码重构
perf: 性能优化
test: 添加或修改测试代码
chore: 构建过程或辅助工具的变动

Scope (影响范围)

指定提交影响的模块或文件范围，例如：

第二课堂
教务系统

Subject (简短描述)

建议使用中文
简单描述修改内容，使用陈述句，例如"修复了xx问题"
结尾不要使用句号或者其他标点符号

规范Git Commit工具

使用VSCode的用户可以安装git-commit-plugin插件，使用效果如下：

v2版本全新发布!

Wed, 20 Aug 2025 00:00:00 +0000

Echo App v2：校园服务小程序的现代化重构实践

项目概述

Echo App v2 是Echo校园服务平台的第二代产品，从微信小程序原生开发(v1)升级而来。本次重构采用了现代化的前端技术栈，为高校师生提供更优质、更稳定的校园数字化服务体验。

🛠️ 技术架构升级

从原生到框架的演进

Echo App v1 基于微信小程序原生开发，随着业务复杂度增加，我们面临以下挑战：

代码复用性差，多端适配成本高
开发效率受限，缺乏现代开发工具链
维护成本逐渐增加

现代化技术选型

基于以上考虑，v2版本采用了业界主流的前端框架组合：

跨端开发框架: 选用成熟的跨端解决方案
组件化开发: 采用现代化的UI组件库
类型安全: 引入静态类型检查提升代码质量
工程化: 完善的开发工具链和构建流程

开发效率提升

新的技术栈带来了显著的开发效率提升：

热重载和实时编译
类型安全的开发体验
丰富的组件生态系统
更好的代码组织和维护性

📁 项目架构设计

目录结构

echo-app-v2/
├── src/ # 源代码目录
│ ├── app.config.ts # 应用配置
│ ├── app.ts # 应用入口
│ ├── assets/ # 静态资源
│ ├── components/ # 公共组件
│ ├── composables/ # Vue组合式函数
│ ├── core/ # 核心工具类
│ ├── pages/ # 主页面
│ ├── toolspage/ # 工具子页面
│ ├── loginpage/ # 登录相关页面
│ └── types/ # TypeScript类型定义
├── config/ # 环境配置
├── modules/ # 子模块
│ └── echo-sdk-ts/ # TypeScript SDK
├── docs/ # 文档
└── package.json # 项目依赖

架构设计理念

项目采用清晰的架构分层：

表现层: 负责界面渲染和用户交互
业务层: 处理核心业务逻辑和数据
优势: 关注点分离，提升可维护性和可测试性

🚀 核心功能实现

1. 课表管理系统

功能特点:

可视化课表展示，支持多种视图模式
课程详情查看和提醒功能
智能的课程数据管理和同步

2. 成绩与绩点计算

功能特点:

成绩查询和统计分析
绩点自动计算
多维度数据展示

3. 校园卡消费分析

功能特点:

消费明细查询和管理
余额实时监控
消费数据统计分析

4. 统一认证系统

安全特性:

安全的身份认证机制
完善的会话管理
自动化的token维护

🎨 UI/UX 设计实践

UI设计理念

设计原则

一致性: 统一的视觉风格和交互模式
易用性: 简洁直观的操作流程
美观性: 现代化的界面设计

用户体验优化

流畅的页面切换动画
智能的加载状态提示
人性化的错误处理机制

响应式设计

移动端优先的设计理念
自适应布局系统
手势操作支持

🔧 开发实践总结

1. 类型安全开发

采用严格的类型检查机制，确保代码质量和开发效率：

完整的类型定义体系
编译时错误检测
更好的代码提示和自动补全

2. 组件化开发模式

基于现代化的组件开发理念：

可复用的组件设计
清晰的组件接口定义
统一的组件通信机制

3. 性能优化实践

实施多项性能优化措施：

代码分割和懒加载
资源优化和压缩
数据缓存策略
渲染性能优化

🧪 质量保证体系

测试策略

建立完善的质量保证体系：

单元测试覆盖核心业务逻辑
集成测试确保模块间协作
端到端测试验证完整用户流程

代码质量

实施严格的代码质量管理：

代码规范检查和自动格式化
静态代码分析
定期的代码审查

📦 部署与发布

构建发布流程

建立标准化的构建发布流程：

多环境配置管理
自动化构建脚本
版本控制和发布管理

环境管理

支持多环境部署：

开发环境用于功能验证
测试环境用于质量保证
生产环境服务真实用户

🚀 性能表现

通过技术架构升级，项目在以下方面获得显著提升：

加载性能: 更快的页面加载速度
运行效率: 更流畅的用户操作体验
资源占用: 更优化的内存使用
稳定性: 更可靠的系统运行

💡 重构经验总结

成功经验

从微信小程序原生开发(v1)升级到现代化框架(v2)带来了显著收益：

开发效率提升: 现代化的开发工具和框架显著提高了开发效率
代码质量改善: 类型安全和组件化开发提升了代码质量
维护成本降低: 清晰的架构分层降低了长期维护成本
跨端能力增强: 具备了向多平台扩展的技术基础

技术挑战与解决方案

在重构过程中面临的主要挑战：

技术栈迁移: 平稳地从原生开发过渡到框架开发
性能平衡: 在功能丰富性和性能表现间找到最佳平衡
兼容性保障: 确保新版本与原有功能的兼容性
团队适配: 帮助开发团队适应新的技术栈和开发模式

📚 学习资源

官方文档

🤝 贡献指南

项目遵循以下规范：

代码规范: ESLint + Prettier
提交信息: Conventional Commits
分支策略: Git Flow
文档要求: 代码注释 + Markdown文档

📞 技术支持

GitHub:
公众号: SIT回应工作室

Echo App v2 项目展示了现代前端技术栈在校园服务领域的成功实践，为高校数字化建设提供了优秀的技术解决方案。通过Taro+Vue+TypeScript+NutUI的组合，我们实现了高性能、跨平台、易维护的校园服务小程序，为师生提供了便捷的数字化校园体验。

博客 | Echo-SIT

Git Commit规范

基本介绍

规范内容

Commit信息格式

Type (提交类型)

Scope (影响范围)

Subject (简短描述)

规范Git Commit工具

v2版本全新发布!

Echo App v2：校园服务小程序的现代化重构实践

项目概述

🛠️ 技术架构升级

从原生到框架的演进

现代化技术选型

开发效率提升

📁 项目架构设计

目录结构

架构设计理念

🚀 核心功能实现

1. 课表管理系统

2. 成绩与绩点计算

3. 校园卡消费分析

4. 统一认证系统

🎨 UI/UX 设计实践

UI设计理念

设计原则

用户体验优化

响应式设计

🔧 开发实践总结

1. 类型安全开发

2. 组件化开发模式

3. 性能优化实践

🧪 质量保证体系

测试策略

代码质量

📦 部署与发布

构建发布流程

环境管理

🚀 性能表现

💡 重构经验总结

成功经验

技术挑战与解决方案

📚 学习资源

官方文档

推荐工具

🤝 贡献指南

📞 技术支持