TE
科技回声
首页24小时热榜最新最佳问答展示工作
GitHubTwitter
首页

科技回声

基于 Next.js 构建的科技新闻平台,提供全球科技新闻和讨论内容。

GitHubTwitter

首页

首页最新最佳问答展示工作

资源链接

HackerNews API原版 HackerNewsNext.js

© 2025 科技回声. 版权所有。

Show HN: Guide to better pull requests and code review

49 点作者 scastiel超过 1 年前
I listed all the advice I give about Pull Requests and Code Review into a short (37 pages) and free guide, with real-life examples and actionable insights.

1 comment

vintagedave超过 1 年前
I read this yesterday and thought it was a nice document. I saw the post still high on HN today... and zero comments. You&#x27;re getting upvotes, so clearly people like it! There is a theory that the best way to generate discussion is to be subtly wrong, and so possibly this means that every reader agreed with what you said.<p>First: kudos on writing this down and sharing it under a permissive license. It&#x27;s great to contribute like that, and it takes effort to produce something and generosity to license it as CC.<p>Feedback: not much, I liked it. But I want to be as useful as possible so here are my thoughts.<p>Reading, I was surprised to jump straight in to &quot;Create your PR before the code is ready for review&quot;, because somehow I expected more of a soft landing. But I realised: it&#x27;s a guide for those who know PRs and know why to use PRs, so why not jump in? Still, the intro could contain a final sentence like: &quot;This is not a guide to encourage you to use pull requests. It assumes you already use them and know their usage thoroughly. It is a guide of practical advice how best to use pull requests and achieve the best from code review. Let&#x27;s jump right in.&quot;<p>Also, on code review, one technique I find useful which I didn&#x27;t see is asking questions. You did suggest to ask for clarifications, but I think this is subtly different. Sometimes, you review code you don&#x27;t know: it&#x27;s ok to admit ignorance and say, &quot;I&#x27;m unfamiliar with this library, but the method name implies... are you sure that...?&quot; Or, you can see someone made a decision, and it can be perfectly fine, but it can be useful to ask about it in order to get it documented.<p>A good code review is also a form of documentation, and can be referred back to later.
评论 #37891868 未加载