Skip to content

Commit bf36458

Browse files
committed
Editing
1 parent 0289986 commit bf36458

File tree

2 files changed

+24
-7
lines changed

2 files changed

+24
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The list was inspired by [The Principles of Good Programming](http://www.artima.
1414
* [Keep Things DRY](#keep-things-dry)
1515
* [Code For The Maintainer](#code-for-the-maintainer)
1616
* [Avoid Premature Optimization](#avoid-premature-optimization)
17-
* [Boyscout Rule](#boyscout-rule)
17+
* [Boy-Scout Rule](#boy-scout-rule)
1818

1919
### Inter-Module/Class
2020

@@ -354,20 +354,19 @@ Resources
354354

355355
* [Interface segregation principle](https://en.wikipedia.org/wiki/Interface_segregation_principle)
356356

357-
## Boyscout Rule
357+
## Boy-Scout Rule
358358

359-
The boyscout rule states that we should always leave the code cleaner than we found it.
359+
The Boy Scouts of America have a simple rule that we can apply to our profession: "Leave the campground cleaner than you found it". The boy-scout rule states that we should always leave the code cleaner than we found it.
360360

361361
Why
362362

363-
* When making changes to an existing codebase the code quality tends to degrade accumulating technical debt. Following the boyscout rule, we should mind the quality with each commit. Technical debt is resisted by continuous refactoring, no matter how small.
363+
* When making changes to an existing codebase the code quality tends to degrade, accumulating technical debt. Following the boyscout rule, we should mind the quality with each commit. Technical debt is resisted by continuous refactoring, no matter how small.
364364

365365
How
366366

367-
* With each commit make sure it does not degrade the codebase quality
368-
* Any time someone sees some code that isn't as clear as it should be, they should take the opportunity to fix it right there and then
367+
* With each commit make sure it does not degrade the codebase quality.
368+
* Any time someone sees some code that isn't as clear as it should be, they should take the opportunity to fix it right there and then.
369369

370370
Resources
371371

372372
* [Opportunistic Refactoring](http://martinfowler.com/bliki/OpportunisticRefactoring.html)
373-
* [Clean Code: A Handbook of Agile Software Craftsmanship](http://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882)

index.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ The list was inspired by [The Principles of Good Programming](http://www.artima.
2121
* [Keep Things DRY](#keep-things-dry)
2222
* [Code For The Maintainer](#code-for-the-maintainer)
2323
* [Avoid Premature Optimization](#avoid-premature-optimization)
24+
* [Boy-Scout Rule](#boy-scout-rule)
2425

2526
### Inter-Module/Class
2627

@@ -359,3 +360,20 @@ How
359360
Resources
360361

361362
* [Interface segregation principle](https://en.wikipedia.org/wiki/Interface_segregation_principle)
363+
364+
## Boy-Scout Rule
365+
366+
The Boy Scouts of America have a simple rule that we can apply to our profession: "Leave the campground cleaner than you found it". The boy-scout rule states that we should always leave the code cleaner than we found it.
367+
368+
Why
369+
370+
* When making changes to an existing codebase the code quality tends to degrade, accumulating technical debt. Following the boyscout rule, we should mind the quality with each commit. Technical debt is resisted by continuous refactoring, no matter how small.
371+
372+
How
373+
374+
* With each commit make sure it does not degrade the codebase quality.
375+
* Any time someone sees some code that isn't as clear as it should be, they should take the opportunity to fix it right there and then.
376+
377+
Resources
378+
379+
* [Opportunistic Refactoring](http://martinfowler.com/bliki/OpportunisticRefactoring.html)

0 commit comments

Comments
 (0)