seata 代码贡献注意事项

vddsk6oq  于 5个月前  发布在  其他
关注(0)|答案(1)|浏览(52)

为了使您贡献的代码能够更快的得到社区的review和merge,请各位贡献者提交代码时,先check以下注意事项。谢谢!

  • 1.提交pr前先 提交issue ,描述下要做什么和怎么做的思路,防止做了错误的或者重复的实现;
  • 2.一个pr只解决一个问题,在pr信息栏里,添加下pr要解决什么问题及主要实现思路,方便尽快review和merge;
  • 3.提交pr时记得关联自己的账号,修改代码可以在这个pr上继续commit代码,不需要每一次修改都关闭老的提新的pr;
  • 4.未完成的pr加个[WIP]前缀,开发完成需要review时去掉前缀,防止被人review半成品的代码;
  • 5.一个类里做了大量修改或者新增,可以追加自己@author 名字/id;
  • 6.pr在去掉[WIP]后,可能会不断有人review留言,尽量及时关注留言和回复,以加快review速度;
  • 7.pr在review期间,主干分支(develop)随时会有新代码merge,需要及时关注自己pr,及时merge主干代码;
  • 8.提交pr时,确保本地mvn test全部通过,每次提交代码后注意CI/CD信息,报错了及时处理;
  • 9.pr提交后,记得在changes目录下的中英文.md文件中添加pr记录;

相关问题