Skip to content

Instantly share code, notes, and snippets.

View code-reaper08's full-sized avatar
🔄
To iterate is human, to recurse divine.

Vishwa R code-reaper08

🔄
To iterate is human, to recurse divine.
View GitHub Profile
@code-reaper08
code-reaper08 / clean_code.md
Created September 30, 2022 18:20 — forked from wojteklu/clean_code.md
Summary of 'Clean code' by Robert C. Martin

Code is clean if it can be understood easily – by everyone on the team. Clean code can be read and enhanced by a developer other than its original author. With understandability comes readability, changeability, extensibility and maintainability.


General rules

  1. Follow standard conventions.
  2. Keep it simple stupid. Simpler is always better. Reduce complexity as much as possible.
  3. Boy scout rule. Leave the campground cleaner than you found it.
  4. Always find root cause. Always look for the root cause of a problem.

Design rules

Commit Message Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>