nnguyenquangg/clean-code-javascript

clean-code-javascript is a reference guide that helps JavaScript developers write code that's easier to read, reuse, and maintain. It translates the classic software engineering principles from Robert C. Martin's book "Clean Code" into practical examples specifically for JavaScript. Think of it as a style companion rather than a strict rulebook, it shows you "bad" versus "good" ways to write the same code so you can develop habits that keep your codebase healthy as it grows. The guide walks through everyday decisions like what to name variables, how many arguments a function should accept, and how to avoid duplicating logic. Each principle comes with side-by-side code examples: a messy version and a cleaner version. For instance, instead of naming a variable yyyymmdstr, you'd call it currentDate. Instead of writing one function that does five things, you break it into five focused functions. The categories cover variables, functions, objects, classes, testing, error handling, concurrency, formatting, and comments, basically the full picture of writing maintainable code. This resource is for anyone writing JavaScript who wants their code to be understandable by other people, or by themselves six months later. A startup founder building a prototype, a PM who occasionally writes scripts, or a developer joining an existing team would all benefit. If you've ever looked at code you wrote last week and struggled to understand it, this guide explains why that happens and how to prevent it. Teams can use it as a shared baseline for code quality, so everyone writes in a similar style. The project is notable for its philosophy: these are guidelines, not laws. The introduction acknowledges that software engineering is still a young field, and even experienced developers make mistakes. The framing is forgiving, every piece of code starts as a rough first draft that gets refined over time. That tone makes it approachable for beginners while still offering value to people who've been coding for years.