Clean code is simple and direct. Clean code reads like well-written prose. Clean code never obscures the designer’s intent but rather is full of crisp abstractions and straightforward lines of control.
Grady Booch author of Object Oriented Analysis and Design with Applications
I could list all of the qualities that I notice in clean code, but there is one overarching quality that leads to all of them. Clean code always looks like it was written by someone who cares. There is nothing obvious that you can do to make it better. All of those things were thought about by the code’s author, and if you try to imagine improvements, you’re led back to where you are, sitting in appreciation of the code someone left for you—code left by someone who cares deeply about the craft.
this removes the question of WTH do i do with this repository?
this removes the muda rework because a copy+paste guide is already available
this allows a new-developer-in-the-project to quickly start working on business requirements and not waste time on technical specifics that should’ve already been handled by the author/initial team who worked on the project.
Quick Breakdown of the sections of the proposed README format
Software Developers (Especially Tech Leads) metrics should include “how easy is it to onboard new developers on projects that I led”
this is in contrast to smartass developers who take pride in obfuscating their code because it makes them look smart.
Muda is a Japanese word meaning “futility; uselessness; wastefulness”, and is a key concept in lean process thinking, like the Toyota Production System (TPS) as one of the three types of deviation from optimal allocation of resources (the others being mura and muri). Waste reduction is an effective way to increase profitability.