search

Anduin2017 / HowToCook

程序员在家做饭方法指南。Programmer's guide about how to cook at home (Simplified Chinese only).
https://cook.aiursoft.cn
The Unlicense
66.63k stars 8.69k forks source link

请引入 husky lint-staged 等做代码检查，校验pr 自动校验失败，反复提交修改！ #755

Open yangnuowei88 opened 2 years ago

yangnuowei88 commented 2 years ago

当前代码提交与集成校验不同步，导致提交PR后总失败，匹配起来！

Anduin2017 commented 2 years ago

提交PR后lint失败是因为提交的PR有问题啊……

Anduin2017 commented 2 years ago

Close 因为不知道在说什么……

yangnuowei88 commented 2 years ago

提交的pr 有问题，但是肉眼很难看出来（主要是格式，与内容规则），所以需要在提交代码前借助CI 相关工具，提前也验证，验证不通过不容易提交代码，而不是提交代码不验证，然后等pr 校验不通过过，再回来修改！另外把那个Ruby 的校验工具改成node 版本的吧，markdownlint-cli，这样方便做CI

Anduin2017 commented 2 years ago

Reopen

Anduin2017 commented 2 years ago

我个人是用了vscode里的markdownlint插件，基本上各种小问题都能发现。

不过你说的有道理。只是我感觉，哪怕把策略改成了任何分支、任何仓库的任何提交都进行验证，可能其它开发者也不会注意到这件事……

另外我确实很想把ruby干掉。。现在开发这个玩意儿需要的依赖项太多了

Anduin2017 commented 2 years ago

现在直接在 PR 时，检查提交的内容是否符合markdown格式要求，是实现起来比较容易的了。基本上大家意识到自己PR被打了个大红叉，都去点开这个红叉下面的错误信息看看为什么，然后再回来修。

如果是以前贡献过好多次的贡献者，基本上都知道这个语法大概是什么要求，效率还算可以。主要是很多人第一次来，不知道这个仓库是有检查要求的，也不太会用GitHub的这种，现在的情况就是我一般只看打了绿勾的PR

yangnuowei88 commented 2 years ago

你说的也没错，但你看看，第一次项目上提pr,能一次性过过的能有几个？这个通过率你可以观察，所以说，在提交代码前做检查是很有必要的！

yangnuowei88 commented 2 years ago

现在的痛点是为啥PR通过率那么低，毕竟我们的东西内容为王，就因为格式，术语等，导致优质的内容丢失，这...