禁止未标记的待办事项
要求 TODO 项使用用户标签(@user
)或问题引用(#issue
)进行标注。
没有关联到用户或问题的 TODO 项会变得陈旧,并且难以追溯更多信息。
无效示例
// TODO Improve calc engine
export function calcValue(): number {}
// TODO Improve calc engine (@djones)
export function calcValue(): number {}
// TODO Improve calc engine (#332)
export function calcValue(): number {}
有效示例
// TODO(djones) Improve calc engine
export function calcValue(): number {}
// TODO(@djones) Improve calc engine
export function calcValue(): number {}
// TODO(#332)
export function calcValue(): number {}
// TODO(#332) Improve calc engine
export function calcValue(): number {}