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

科技回声

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

GitHubTwitter

首页

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

资源链接

HackerNews API原版 HackerNewsNext.js

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

Ask HN: Pull request body how detailed should it be?

1 点作者 crtlaltdel超过 5 年前
Our team has the most inconsistent content for pull request body messages I have ever seen. Some will drop a link to a ticket without any other context, some will write a little paragraph that describes the intent of the changes, and still others put the ticket number in their pull request title and leave the body blank.<p>Personally, I enjoy the small narratives. The tickets are usually void of useful technical specifics (beyond maybe what component should be worked on).<p>So, my questions to HN:<p>1. How detailed should one make a pull request body?<p>2.Is there any value in pushing the point? We have lots to do and limited bandwidth, both points the CTO has tossed at me when I raise issues like this.<p>EDIT: format

1 comment

Ahmedb超过 5 年前
All PRs should have a standard format it helps both the reviewers and the author.<p>One thing that works well is to use prefilled template with 3&#x2F;4 main sections.<p>Something like:<p>### What &#x27;Describe your change&#x27;<p>### Why `Describe what drove this change (bugfix, feature, crash,...)`<p>### Links &#x27;Link to ticket or design`<p>### Testing `What should reviewers look for`
评论 #22133493 未加载