Skip to content

评审工作

Tong He edited this page Apr 15, 2017 · 5 revisions

评审工作通过 Pull Request 来进行。


默认情况下 PR 里 显示的是文本差异,有时候可能看不清到底改了什么,此时可以点击一个按钮显示 Markdown 渲染出来的差异,例如:

screen shot 2017-03-17 at 12 36 42 am

评审可以在文本差异模式下对 PR 进行行内评论,鼠标移动到左边栏会显示一个蓝色的加号,点击即可写评审意见,如:

image


写完所有评审意见之后记得点右上角的 Review changes 按钮,最终给一个评审的决定:Comment 表示只是纯评论、Approve 表示批准作者的修改(下一步可以合并了)、Request changes 表示这个 PR 还需要按照评审意见继续改进。

image


如果使用Chrome浏览器,可以安装大为@Lchiffon 做的一个浏览器插件,能在浏览PR的时候很方便地预览对应的被修改文章:https://github.com/Lchiffon/cosxReviewTool

每一篇修改或新提交的文章都会在服务器上自动生成预览,看预览网页比看上面的源文件差异可能更舒服一点。下面的 JavaScript 代码可以自动打开每个 PR 里修改的第一篇文章的预览页面。可以复制粘贴到浏览器的开发者工具的 JavaScript 控制台中运行(注意首先要点到 PR 的差异页面上再运行,即 Files changed 那一栏而不是 PR 的首页):

f = document.querySelector('#diff-0 > div.file-header > div.file-info > a').title.trim().replace(/.*\/|\.md$/g, '').replace(/^([0-9]{4})-([0-9]{2})-([0-9]{2})-(.*)$/g, '$1/$2/$4')
i = location.pathname.replace(/^.*pull\/|\/files.*/g, '')
window.open('https://deploy-preview-' + i + '--cosx.netlify.com/' + f)

合并 PR 时,请展开合并按钮的下拉菜单,用第二个选项“Squash and merge”以保证每个 PR 里的多个 commit 记录被合并成一个记录写入 master 分支(如果听不懂这句话,那么可以解读为“这个选项是为了让主库的历史记录更干净”)。

image

Clone this wiki locally