opdavies/oliverdavies.uk
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Add daily email for 2024-10-30

Browse source 
Code reviews are about the code, not code style
This commit is contained in:
Oliver Davies 2024-11-01 22:39:28 +00:00
parent 4827a6d754
commit 1e52df9a20
1 changed files with 21 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
source/_daily_emails/2024-10-30.md Normal file
View file

@ -0,0 +1,21 @@
---
title: Code reviews are about the code, not code style
date: 2024-10-30
permalink: daily/2024/10/30/code-reviews-are-about-the-code-not-code-style
tags:
- software-development
cta: ~
snippet: |
If you do code reviews, they should be about reviewing the code itself and not about the style of the code.
---
If you do code reviews, they should be about reviewing the code and not about the style of the code.
There shouldn't be comments about whether tabs or spaces are used, how many spaces are on each line, where the braces are, or whether there should be semicolons.
A code style should be defined upfront and checking code against it can be done automatically with tools such as phpcs or Prettier.
You don't need to wait for a human to review the code style - automated tools can be run locally or in a CI pipeline and provide feedback much faster.
And if people aren't reviewing the code style, they can focus on reviewing the code itself.