编写能够验证的规则
先写明验证修改所需的命令、重要源码目录,以及一两项架构约束。“使用已有的表单校验函数”比“编写整洁代码”更容易执行。这些是建议的编写方法,不同工具的文件名和规则启用方式并不相同。
起始指令示例
按照代码仓库情况调整此示例,再通过工具文档说明的规则或指令功能保存。
Before editing, inspect the nearest existing implementation.
Use the package manager already configured in this repository.
Run the relevant checks for changed behavior.
Report any check you could not run and why.
Do not edit generated output directly.验证规则确实生效
尝试一个能看出规则影响的小任务,检查输出和执行的命令。如果规则影响了无关工作,就缩小其适用范围。项目规则应像构建说明一样随代码仓库一起维护。