施工中,待续
需求规格说明书
1. 产品背景
Git是目前最先进的分布式版本控制系统,在软件开发领域占有重要的地位。但对于许多同学来讲,Git bash的使用有些晦涩难懂,且Git反馈的信息大多为英语和一些专用的术语,因此很容易给新手带来困惑。
2. 产品目标
对反馈进行本地化,提供更加友好的中文信息与帮助。并尽量简化用户操作,同时提供向导模式,帮助对Git本身并不了解的同学来学习Git的大致工作流程,进行基本的版本控制。
3.产品用户
初次接触Git,尚不了解Git工作机制的用户,希望能够尽量简单快速的使用Git进行版本控制
4.需求
• 为初学者提供友好的入门指导
• 对Git英文反馈进行翻译,并尽可能以友好易懂的表达向用户反馈错误信息、反馈信息等
• 提供基本的Git操作功能集合
• 可视化历史提交记录
原型设计
环境依赖
代码规范
1. 提交规范
• Feat: 新功能
• Fix: 改bug
• Docs: 写文档/添注释
• Style: 换代码风格 但不影响功能作用
• Refactor: 代码重构 但不影响功能作用
• Test: 单元测试等
• Init: 初始化新的项目文件
2. 提交规范
• 避免在头文件中使用 using namespace ...
• 禁止在头文件中使用 using namespace std
• 当只有数据成员时使用struct,其他情况一律使用class
• 除非必要,否则尽量避免多重继承
• 函数中所有不需要修改的引用形参必须加上const
• 函数名和类名的命名规则:首字母大写,不含下划线 例如 UnitTest、InitRepositories
• 普通变量的命名规则:一律小写,单词之间用下划线连接 例如 file_path、git_username
• 常量和枚举量的命名规则:以k开头,大小写混用 例如 kAge、kCountry
• 请勿内联包含递归或循环的函数
• 若有单参数的类构造函数,建议加上explicit关键字防止隐式类型转换