代码风格和质量指南
1 拉取请求与变更规则
-
ISSUE
/PR
(拉取请求) 的引导和命名- 确保
PR
与ISSUE
相对应。
注意:
Hotfix
问题不需要遵循此规则,例如修复JavaDoc
或document
文件中的拼写错误。- 标题命名格式
当命名PR
时,可以参考拉取请求的[ISSUE-XXXX][Feature/Improve/Refactor/Bug/Cleanup] Title
, 其中ISSUE-XXXX
应替换为实际的ISSUE
编号。- 第二部分描述了
PR
的类型,例如新功能、改进、重构等。 - 如果所有对
PR
的更改都在某个模块或组件内,则可以在提交消息中指示。
- 第二部分描述了
- 确保
-
描述
- 请填写
PR
模板以描述贡献。这样,审阅者可以从描述中,而不仅仅是从代码中,了解问题和解决方案。 - 确保描述足以说明
PR
所解决的问题。 - 小的更改不需要过多的描述。
- 在理想情况下,问题描述在
ISSUE
中,大部分描述都是从那里复制的。
- 请填写
-
尝试将更改分解为纯类型的更改
- 建议
PR
应将诸如Cleanup
、Refactor
、Improve
和Feature
之类的更改排列到分隔的PRs
/Commits
中。 - 这样,审阅者可以独立查看清理和重构,并确保这些更改不会更改行为。
- 然后,审阅者可以独立审查核心更改,并确保它们是干净和健壮的更改。
- 在极端情况下,如果需要回滚提交,它可以为版本回滚选择提供最佳的粒度。
- 建议