Skip to content

Commit f4d6e25

Browse files
committed
docs: initial intro to Clean Code
1 parent ea272dc commit f4d6e25

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

Diff for: docs/code-quality/README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66
77
## Clean Code
88

9-
TODO: WTFs/minute image with introduction to Clean Code.
9+
Robert C. Martin introduces Clean Code with a humorous anecdote about the number of WTFs/minute that a developer might experience when reading poorly written code.
10+
11+
![WTFs/minute](images/wtf.png)
12+
13+
Robert asks the reader to consider which door represents the code they write, or the code they wish to maintain or troubleshoot. The door on the left is clean, well-organised, and easy to navigate. The door on the right is cluttered, disorganised, and difficult to navigate.
14+
15+
Clean Code is fundamental to writing high-quality code - that is, understandable by humans, and maintainable. In Clean Code, Robert presents a set of principles and best practices for writing high-quality and maintainable code.
1016

1117
[Read more](./clean-code.md)

Diff for: docs/code-quality/images/wtf.png

83.2 KB
Loading

0 commit comments

Comments
 (0)