Ignore Whitespace in a GitHub Pull Request

Reviewing a GitHub PR on that contains a lot of whitespace changes? Extra whitespace can make it challenging to evaluate the substance of a PR. It’s high on my list of things that should generally not be refactored. Ignore whitespace by adding the query parameter ?w=1 to your diff URL.

February 22, 2024 · Jake Worth

Link to Headers in GitHub READMEs

Anytime you add a header to a markdown file, GitHub attaches an href with its downcased name. ‘JavaScript’ receives a link to #javascript, for instance. Leverage this by adding a table of contents to your README with links to the headers further down the document: ### Table of Contents - [Cucumber](#cucumber) This will link to a header containing ‘Cucumber’. h/t Josh Branchaud

February 22, 2024 · Jake Worth

Why Great PRs Are Great: Pull Requests Templates

Have you ever seen a pull request that seems to completely explain itself? It’s a real artifact. I don’t know the project, yet I understand it. How can we get results like this on every pull request, from every developer on the team, every time? ...

August 14, 2023 · Jake Worth

All My Best Tips For Expertly Reviewing Your Own Code

Great developers review their own code often and effectively. In this post, I’ll share a checklist of all my best tips for maximizing this important practice. ...

November 12, 2022 · Jake Worth

How I Review Code

Code reviews are important on many teams. Do them well, and your code ships quickly and safely. Do them poorly, and your code ships slowly and riskily. I try to contribute good code reviews. In this post, I’ll share my process. ...

March 6, 2022 · Jake Worth

Don’t miss my next essay

Hear from me immediately when I post: no ads, unsubscribe anytime.