Ep. 25 — Your code can affect many people’s lives, not just your end-users’

There are a few simple things you can do before that final commit to make your code more friendly to everyone.

Photo by Miguel Á. Padriñán from Pexels

a) Your fellow engineers (and successors who you may never meet) will read the source, digest the change history, fix bugs and delete chunks of it gingerly in the years to come.

b) Your colleagues on the Release team will read your code to figure out why the build stops working on a Friday afternoon. Is it the code, the tests, the toolchain upgrade or an underlying OS patches that broke it?

c) The infrastructure team, who may be in a different city, will try to decipher the logs and error messages your code created to figure out what to do next? Should they restart the servers, route traffic to backup sites, or rollback the changes to protect the integrity of the overall system?

Here is simple list of actions that your colleagues will thank you for.

  1. Clean logs: Spend the extra time to review the console logs before you check in the final version. Do your best to clean up those WARNING that doesn’t affect end users functionality. So, others won’t mistake them as actual warning signs of trouble or security breaches.

Happy coding.

I enjoy learning, creative engineering & reading. Evergreen-labs.com, Vaccine-Ontario.ca, TravelShoppingBuddy.com, Sidekick-app.com, Tangerine.ca