Pull Request Check List

参加 BOT5 沙龙需要提交 Pull Request。

https://github.com/wechaty/bot5.club 项目中,以 Pull Request 的形式,将自己想分享的主题进行内容提交。

注意:请在各自的 Pull Request 的描述中,引用本会议纪要的 issue URL,以便于会议纪要进行追踪。

轮值主席在收到大家的PR后,在会议通知发送之前进行Merge。

注意:

  1. 在各自的 Pull Request 的描述中,引用本会议纪要的 issue URL,以便于会议纪要进行追踪。
  2. 在 Pull Request 中,说明自己是属于 Oral 还是 Poster.
  3. Pull Request 需要至少一个人 review approve 之后,才能 merge
  4. Pull Request 需要通过 CI (Continous Integration) testing 之后,才能被 merge
  5. CI 对文件名的要求:/$[a-z0-9\-\.]+$/ 注意我们统一用 - 而不用 _
  6. CI 对图片的要求:尺寸不能超过2MB;同时如果宽度超过了 1920 ,那么需要用 ./scripts/fit-image.sh 处理一下,压缩到 1920 宽度的分辨率,以加快网页加载速度
  7. Pull Request 如果是 Oral 或者 Poster 的报名,那么必需要以 /^(🗣|📰)/ 开头,请大家注意标题要符合模板
  8. 发起PR的时候可能会存在多条commit,所以在合并PR的时候,尽可能的选择Squash and merge,使得整个repo的commit history看起来更加清爽

有任何问题,大家可以随时在群里面提出讨论。

Contributing

  1. Fork it
  2. Create your paper branch (git checkout -b my-new-paper)
  3. Commit your changes (git commit -am ‘Added some paper’)
  4. Push to the branch (git push origin my-new-paper)
  5. Create a new Pull Request