Clean Code: Writing for Humans
"Any fool can write code that a computer can understand. Good programmers write code that humans can understand." — Martin Fowler.
1. Meaningful Names
Variables and functions should reveal their intent.
- Bad:
let d; // days elapsed - Good:
let daysElapsed;
2. Functions should do One Thing
A function should be small and focused. If a function has more than 20 lines, it might be doing too much.
3. Avoid Comments (mostly)
Code should be self-documenting. If you need a comment to explain what the code does, your code is probably not clear enough. Only use comments to explain the why (decisions/rationale).
4. DRY (Don't Repeat Yourself)
Every piece of knowledge should have a single, unambiguous representation within a system. Duplicate code is a maintenance nightmare.
5. Boy Scout Rule
"Always leave the campground cleaner than you found it." If you see messy code while working on a feature, clean it up!
The Power of Small Commits
Clean code isn't just about the files; it's about the process. Frequent, small, and descriptive commits make it easier for others to review your changes and understand the evolution of the project.