Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 1.92 KB

HowToContribute.md

File metadata and controls

50 lines (32 loc) · 1.92 KB

如果你想为LMC贡献代码,务必遵守此文件内容(虽然我自己都不一定遵守就是了)

因为我懒,没怎么排版。

命名规范

C#代码

在命名private static变量时,务必使用s_+小驼峰,如s_account。

在命名public的任意项必须使用大驼峰。

在命名private非static变量时,务必使用_+小驼峰,如_logger。

在命名方法、类、命名空间时,务必使用大驼峰。

若命名过于长,可适当使用简称,但是务必要让人能看懂。

UI

x:Name等项应尽量简便、不易与代码混淆。但是不要过于简便,事实上,在UI中的命名可以相当随意,只要人能看懂。

配置文件

对于Key项,人能看懂即可。对于Section项,应当在前者与易用之间做平衡。

其他

对于日志中module项,使用当前类名大写字母,若与其他模块重复,自行添加用于辨别。

代码自检

请务必试运行,以确保:

  • 不会导致UI线程卡顿
  • 所有可在编译时预测的异常均被合理catch
  • 在适当的位置有日志输出
  • 用户的隐私相关内容均加密,尽量使其没有在日志中输出token等内容的可能性
  • 没有在后台线程的死循环等内容,每个资源在用完后应适时Dispose
  • 不会导致LMC的内存占用超过500MB
  • 不会导致已有的稳定必须功能正常运行(重写等除外)
  • ...

若无法确保上述内容,请在提交pull-request时标注。

Commit Message

尽量每次Commit只完成一项,使用gitmoji.js.org中的表情作为Message的开头,空格后加简介。

如果Commit中有多个项,以改动最大的项作为第一项,后面每行一项。

可以但不建议使用普通的纯文字Message,如 feat: Microsoft Login。

尽量使用中文。

千万补药使用其他语言的dll(除非everything这种)、exe等来辅助程序!!!