Closed Amazingkenneth closed 1 year ago
Thank you for your submission, we really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.
我也考虑过使用 CI 进行格式化,关于这个 pr 也有一点想法:
uses: huacnlee/autocorrect-action@main
Github Action 最好应该使用指定的 release 版本,而不是直接使用 main 分支。这样可以避免由于工具主分支意外错误合并或提交造成的影响,从而保证 CI 的稳定性。
Lint 工具的默认格式配置可能与现有工程的代码风格和注释不完全匹配,应该需要做额外配置。我注意到在现有的部分代码中函数注释的风格是使用英文冒号和一个空格将关键字和内容进行分隔 * 函数名称: Init_BH1750
,而没有使用中文冒号连在一起 * 函数名称:Init_BH1750
。应该要遵从现有的工程代码和原代码贡献者的格式化风格。
使用 Lint 工具的话,如果考虑格式化 Markdown 文档,Prettier / markdownlint 等这样的自动化工具既可以完成中英文拼写的检查,还能自动修正 Md 文件中的格式和语法问题。它们也提供了更丰富的配置选项和社区支持。或许可以交由社区讨论下要使用什么工具和代码风格格式化的规则。
目前已经改为使用 prettier 作为文档和代码的规范工具,并且修复了与原先注释风格不一致的问题,如果觉得还有什么问题可以提出来,我们一起完善
感谢两位同学的贡献,我先把这个合入进去,如果有啥问题,辛苦两位同学持续完善,谢谢!
tools/mdk_pack/Documentation/README.md
等四个文件的修改mian 函数
的拼写错误