Services

Audit the code before you change it

A change is safer after someone has read the code around it. The audit is that reading, written so the next edit has a map.

This is not a score and it is not a rewrite proposal. It is a pass through the modules people are afraid to touch, and the ones that are fine.

When it fits

  • There are modules people are afraid to touch.
  • You are about to change, upgrade, or take over code you did not write.
  • A new developer needs a map before the first edit.

How the work goes

  1. We follow one real request from the route to the database and back.
  2. Along the way we note duplicated rules, missing tests, and the places where a small edit would spread.
  3. The write-up names files. It says what to change first, what to leave, and which test would catch a mistake.
  4. The write-up is handed to the person who will do the work, in a form they can use without us.

Example: mark a line

Read first

Click a line from the code you already run. The note is the finding, before any rewrite.

What you receive

  • A map of the paths a real request takes
  • A short list of changes that are safe, and changes that are not
  • Tests worth adding before the next feature, named by file

How to start

Send access to the repository, or a description of the stack, and the part of the code you worry about. Email it to info@developerlab.nl, or see the contact page for other ways to reach Puya Sarmidani.

Send an email

Related services

All services