LK/x
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[文档] 优化处理开发说明(修复开发说明未按预期换行的问题, 添加开发说明中的提交规范)

Browse Source
This commit is contained in:
寻觅(樊旭东) 2024-02-03 09:54:45 -05:00
parent 9e8c0e47c5
commit 545862c160
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -25,11 +25,16 @@
>
> 备注: 主机信息可以使用 `uname -mvr`命令查看, 时间为发生问题的时间(大概就可以)
开发说明: 本项目允许使用使用中文变量名 (受限于sh\bash本身不支持使用中文, 不要在bash中使用中文), 使用中文的目的为增加本项目开发人员的代码可读性, 非强制要求
> 多词组合命名规范
> 中文变量名推荐格式: `动词_名称`, 比如`打开_文件`、`检测_内存`
> 主要是将常用词语放在前面方便分类, 如果名词+名称组合, 可以参考如下实例: `系统_类型` `系统_版本` `系统_发行版` `系统_发行版_名称`, 根据名词使用频率排序
> 英文变量名使用小驼峰命名
* 开发说明: 本项目允许使用使用中文变量名 (受限于sh\bash本身不支持使用中文, 不要在bash中使用中文), 使用中文的目的为增加本项目开发人员的代码可读性, 非强制要求
> * 多词组合命名规范
> * 中文变量名推荐格式: `动词_名称`, 比如`打开_文件`、`检测_内存`
> * 主要是将常用词语放在前面方便分类, 如果名词+名称组合, 可以参考如下实例: `系统_类型` `系统_版本` `系统_发行版` `系统_发行版_名称`, 根据名词使用频率排序
> * 英文变量名使用小驼峰命名
> * git提交时务必编写明确的提交说明,提交时请携带类型, 类型主要分类如下:
> * `[新增]`: 添加新功能, 新接口
> * `[更新]`: 更新依赖模块, 或者更新优化代码, 并未添加新功能
> * `[文档]`: 跟新文本类信息, 为修改项目代码(包含项目内的注释, print输出等)
> * `[混合]`: 同时包含上述多种分类的更新提交, 此类提交需要具体描写扩展描述
# 备注
`言灵` 是我在中学时期很喜欢的小说 《龙族》 中人龙混血后代所具有的特殊能力的一种统称, 同时又满足了本项目想在命令行中让我们自己的母语也能管用的功能