The comments that go into code versus those that go into the pull request description

This article discusses the importance of distinguishing between comments in code and those in pull request descriptions. It emphasizes how clear titles and descriptions can aid in understanding changes and tracking down regressions.

From the article

When you submit a pull request, there are two places you can use to help explain what you are doing and why you are doing it. One is the pull request description, and another is the code you are modifying. And it’s important to understand the difference between them.

The pull request is where you justify why your change should be accepted. In the title, you spell out the problem you are fixing or the feature you are adding.

In a large code base, you may need to be a little more specific.

Share this resource