How to write good code

Writing good code is about more than just making it work—it's about making it readable, maintainable, and efficient. Here are some key principles to follow:

---

🚀 1. Write Clean and Readable Code

• Use meaningful variable and function names:

  
  // Bad
  let x = 5;
  function d(a, b) { return a + b; }
  
  // Good
  let itemCount = 5;
  function calculateSum(num1, num2) { return num1 + num2; }
  

• Keep functions short and focused:
  A function should do one thing and do it well.

• Consistent formatting:
  Use proper indentation, spacing, and line breaks to enhance readability.

---

🔄 2. Follow the DRY Principle (Don’t Repeat Yourself)

• Avoid duplicating code. Instead, create reusable functions or components:

  
  // Bad
  console.log("Welcome, Alice!");
  console.log("Welcome, Bob!");
  
  // Good
  function greetUser(name) {
    console.log(`Welcome, ${name}!`);
  }
  greetUser("Alice");
  greetUser("Bob");
  

---

🧪 3. Write Testable Code

• Break code into small functions that can be easily tested.
• Use unit tests to verify functionality (e.g., with Jest or Mocha).

---

🗃️ 4. Organize Your Code

• Structure your project logically:

  
  /src
    /components
    /utils
    /services
  

• Group related files together (by feature or module).

---

🛡️ 5. Handle Errors Gracefully

• Don’t ignore potential errors:

  
  try {
    const data = JSON.parse(jsonString);
  } catch (error) {
    console.error("Invalid JSON:", error);
  }
  

---

📄 6. Write Clear Comments (When Necessary)

• Explain why something is done, not what is done (if the code is already clear).

  
  // Bad comment
  // Increment i by 1
  i++;
  
  // Good comment
  // Increment counter to track the number of attempts
  attemptCount++;
  

---

⚡ 7. Optimize for Performance

• Use efficient algorithms and data structures.
• Avoid unnecessary computations:

  
  // Bad
  for (let i = 0; i < items.length; i++) {
    console.log(items[i]);
  }
  
  // Good (caching the length)
  for (let i = 0, len = items.length; i < len; i++) {
    console.log(items[i]);
  }
  

---

📦 8. Use Version Control (Git) Properly

• Write meaningful commit messages:

  
  git commit -m "Fix login bug by handling null user sessions"
  

• Make small, focused commits for each change.

---

♻️ 9. Refactor Regularly

• Constantly improve your code as you learn better ways to solve problems.
• Refactoring reduces technical debt and improves maintainability.

---

👥 10. Collaborate Effectively

• Participate in code reviews and be open to feedback.
• Read other people’s code to learn new patterns and techniques.