首页 > 其他分享 >PRspecification

PRspecification

时间:2023-01-11 18:34:19浏览次数:30  
标签:pr PR 一个 PRspecification 某个 组件 commit

Pull Request规范

概述:

PullRequest 需要遵守的原则:

  • 一个pr只围绕一件事
  • 避免过大的pr

一个pr只围绕一件事

一个pr应该只负责一件事,这遵循设计模式中的单一职责原则

比如:

  • 处理了一个issue
  • 解决了一个Bug
  • 新增了一个功能
  • 重构代码实现了某种目的

一个pr可以有多个commit,但要注意尺度,保证pr不会过大

避免过大的pr

一个pr的文件改变最好少于12个文件

信息填写

Title 格式

PR 仅包含一个 commit

直接使用 github 默认填写的信息,即 title 为 commit msg 的 subject 部分,Content 为 commit msg 的 body 部分

PR 包含多个 commit

描述清楚这个 PR 所做的事情,格式:[名词] + 动词 + [名词] + [形容词] + [名词]

例如:

  • 修复 Collapse 组件无法展开的问题
  • 添加某个属性
  • 新增某个组件
  • 删除某个组件的某个属性

动词

标签:pr,PR,一个,PRspecification,某个,组件,commit
From: https://www.cnblogs.com/chicc/p/17044615.html

相关文章