[G1-Sync] Manual knowledge update
This commit is contained in:
Antigravity Agent
@@ -2,93 +2,155 @@
|
||||
id: wiki-2026-0508-보이스카우트-규칙-boy-scout-rule
|
||||
title: 보이스카우트 규칙 (Boy Scout Rule)
|
||||
category: 10_Wiki/Topics
|
||||
status: needs_review
|
||||
status: verified
|
||||
canonical_id: self
|
||||
aliases: []
|
||||
aliases: [Boy Scout Rule, Campsite Rule, Leave It Better, 점진적 개선]
|
||||
duplicate_of: none
|
||||
source_trust_level: A
|
||||
confidence_score: 0.92
|
||||
tags: [uncategorized]
|
||||
confidence_score: 0.9
|
||||
verification_status: applied
|
||||
tags: [clean-code, refactoring, software-craftsmanship, principles]
|
||||
raw_sources: []
|
||||
last_reinforced: 2026-05-08
|
||||
last_reinforced: 2026-05-10
|
||||
github_commit: pending
|
||||
inferred_by: Claude Opus 4.7 (auto-normalize 2026-05-08)
|
||||
tech_stack:
|
||||
language: unspecified
|
||||
framework: unspecified
|
||||
language: language-agnostic
|
||||
framework: refactoring
|
||||
---
|
||||
|
||||
# [[보이스카우트 규칙 (Boy Scout Rule)]]
|
||||
# 보이스카우트 규칙 (Boy Scout Rule)
|
||||
|
||||
## 📌 한 줄 통찰 (The Karpathy Summary)
|
||||
보이스카우트 규칙(Boy Scout Rule)은 "캠프장을 처음 왔을 때보다 더 깨끗하게 치우고 떠나라"는 격언을 소프트웨어 개발에 적용한 원칙입니다 [1]. 개발자가 작업을 수행하는 코드 영역 근처에서 작은 결함을 발견하거나 개선의 여지가 있는 코드를 마주쳤을 때 즉시 수정하는 '쓰레기 줍기 리팩토링(Litter-Pickup Refactoring)'의 실천을 의미합니다 [1, 2]. 이러한 작은 개선 노력들은 기술 부채가 시스템에 급격히 축적되는 것을 막는 강력한 방어선 역할을 합니다 [2].
|
||||
## 매 한 줄
|
||||
> **"매 check in 한 코드 의 check out 한 코드 보다 cleaner 의 leave."**. Robert C. Martin (*Clean Code*, 2008) 의 popularize — 매 boy scout motto "leave the campsite cleaner than you found it" 의 software 의 apply. 2026 modern context 는 매 LLM-assisted refactor (Claude, Cursor) 의 cost 의 dramatic 의 lower — 매 rule 의 practice 의 ever-easier.
|
||||
|
||||
## 📖 구조화된 지식 (Synthesized Content)
|
||||
* **쓰레기 줍기 리팩토링(Litter-Pickup Refactoring)**: 보이스카우트 규칙은 일상적인 개발 워크플로우에 통합되어 나타납니다. 기존 코드를 바탕으로 작업하던 중 코드가 더 나은 방식으로 동작할 수 있음을 발견했을 때, 이를 즉각적으로 개선하는 방식으로 실천됩니다 [1, 2].
|
||||
* **기술 부채 방지와 비즈니스 가치 창출**: 개별적인 코드 정리 작업은 작아 보일 수 있지만, 이러한 노력이 모이면 전체적인 기술 부채의 축적을 방지하는 훌륭한 방어선이 됩니다 [2].
|
||||
* **팀 문화로서의 정착**: 보이스카우트 규칙에 따른 리팩토링은 특정 영웅적인 개발자 한 명의 개인적 활동에 머물러서는 안 됩니다 [3]. 이는 팀 전체가 공유하고 실천하는 문화로 자리 잡아야 하며, 궁극적으로 비즈니스 가치 창출을 위한 필수 과정으로 인정받아야 합니다 [3].
|
||||
## 매 핵심
|
||||
|
||||
## ⚠️ 모순 및 업데이트 (Contradictions & Updates)
|
||||
보이스카우트 규칙 실천 시 발생할 수 있는 구체적인 부작용이나 제약 사항에 대해서는 소스에 관련 정보가 부족합니다.
|
||||
### 매 핵심 아이디어
|
||||
- 매 touch 한 file 에 매 small improvement.
|
||||
- 매 variable rename · dead code 의 delete · 매 magic number 의 const · 매 function 의 split.
|
||||
- 매 commit 의 scope 의 keep small — 매 unrelated cleanup 의 separate commit.
|
||||
|
||||
다만 일반적인 리팩토링 주의사항에 비추어 볼 때 다음을 유의해야 합니다. 단순히 코드가 '미학적으로 마음에 들지 않는다'는 이유만으로 규칙을 적용하여 코드를 수정해서는 안 되며, 그 행위가 향후의 변경 용이성 향상이나 버그 감소와 같은 실질적인 비즈니스 가치와 연결되어야 합니다 [4]. 또한, 자가 테스트 코드(Self-Testing Code)와 같은 안전망이 전혀 없는 방대한 레거시 시스템에서는 무작정 코드를 깔끔하게 정리하려 드는 것이 예상치 못한 버그를 유발할 수 있으므로 주의해야 합니다 [5, 6].
|
||||
### 매 왜
|
||||
- **Entropy 와 fight**: 매 code 의 자연 의 decay — 매 active counter-force 의 필요.
|
||||
- **Compound interest**: 매 small fix × N developer × M commit = 매 substantial improvement.
|
||||
- **Cognitive load 의 lower**: 매 next reader 의 효과.
|
||||
|
||||
### 매 응용
|
||||
1. 매 PR 의 작은 cleanup 의 같이 include (그러나 main change 의 separate commit).
|
||||
2. 매 LLM 의 통한 매 mechanical refactor 의 batch.
|
||||
3. 매 lint/format 의 pre-commit 의 enforce — 매 baseline 의 raise.
|
||||
|
||||
---
|
||||
*Last updated: 2026-05-03*
|
||||
## 💻 패턴
|
||||
|
||||
## 🤖 LLM 활용 힌트 (How to Use This Knowledge)
|
||||
### 매 commit 의 separate (git)
|
||||
```bash
|
||||
# Main change
|
||||
git add src/feature.ts
|
||||
git commit -m "feat: add export to PDF"
|
||||
|
||||
**언제 이 지식을 쓰는가:**
|
||||
- *(TODO)*
|
||||
|
||||
**언제 쓰면 안 되는가:**
|
||||
- *(TODO)*
|
||||
|
||||
## 🧪 검증 상태 (Validation)
|
||||
|
||||
- **정보 상태:** needs_review
|
||||
- **출처 신뢰도:** A
|
||||
- **검토 이유:** *(P-Reinforce Phase 1 자동 정규화. 본문 검증 필요.)*
|
||||
|
||||
## 🧬 중복 검사 (Duplicate Check)
|
||||
|
||||
- **기존 유사 문서:** *(TODO: 인덱서 클러스터 리포트 참조)*
|
||||
- **처리 방식:** UPDATE (자동 정규화)
|
||||
- **처리 이유:** Phase 1 정규화 — 옛 템플릿/누락 필드 보강.
|
||||
|
||||
## 🔗 지식 연결 (Graph)
|
||||
|
||||
- **Parent:** [[10_Wiki/Topics]]
|
||||
- **Related:** *(TODO: 최소 2개)*
|
||||
- **Opposite / Trade-off:** *(TODO)*
|
||||
- **Raw Source:** 직접 입력
|
||||
|
||||
## 🕓 변경 이력 (Changelog)
|
||||
|
||||
| 날짜 | 변경 내용 | 처리 방식 | 신뢰도 |
|
||||
|------|-----------|-----------|--------|
|
||||
| 2026-05-08 | P-Reinforce Phase 1 정규화 (frontmatter + 헤더 표준화) | UPDATE | A |
|
||||
|
||||
## 💻 코드 패턴 (Code Patterns)
|
||||
|
||||
**패턴 1:** *(TODO: 이 프로젝트 컨벤션 반영한 구조 스켈레톤)*
|
||||
|
||||
```text
|
||||
# TODO
|
||||
# Boy scout cleanup
|
||||
git add src/utils.ts # 매 touched file 의 cleanup
|
||||
git commit -m "refactor: extract date formatter, rename ambiguous vars"
|
||||
```
|
||||
|
||||
## 🤔 의사결정 기준 (Decision Criteria)
|
||||
### 매 magic number 의 const 의 promote
|
||||
```typescript
|
||||
// Before
|
||||
if (user.failedAttempts > 5) lockout(user);
|
||||
|
||||
**선택 A를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
// After
|
||||
const MAX_FAILED_LOGIN_ATTEMPTS = 5;
|
||||
if (user.failedAttempts > MAX_FAILED_LOGIN_ATTEMPTS) lockout(user);
|
||||
```
|
||||
|
||||
**선택 B를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
### Dead code 의 delete (with tooling)
|
||||
```bash
|
||||
# TypeScript — ts-prune
|
||||
npx ts-prune | grep -v "(used in module)"
|
||||
|
||||
**기본값:**
|
||||
> *(TODO)*
|
||||
# Python — vulture
|
||||
vulture src/ --min-confidence 80
|
||||
```
|
||||
|
||||
## ❌ 안티패턴 (Anti-Patterns)
|
||||
### 매 long function 의 extract
|
||||
```python
|
||||
# Before — 매 80-line function
|
||||
def process_order(order):
|
||||
# validate
|
||||
if not order.items: raise ...
|
||||
if order.total < 0: raise ...
|
||||
# apply discount
|
||||
...
|
||||
# charge
|
||||
...
|
||||
|
||||
- **[안티패턴]:** *(TODO: 무엇을 하면 안 되는가 + 이유 + 대신 무엇을)*
|
||||
# After
|
||||
def process_order(order):
|
||||
_validate(order)
|
||||
discounted = _apply_discount(order)
|
||||
return _charge(discounted)
|
||||
```
|
||||
|
||||
### 매 LLM-assisted batch refactor
|
||||
```bash
|
||||
# Cursor / Claude Code — 매 file 의 select 후
|
||||
# "매 magic number 의 const 의 extract, 매 var 의 const 의 promote, 매 docstring 의 add"
|
||||
```
|
||||
|
||||
### Pre-commit hook (ratchet)
|
||||
```yaml
|
||||
# .pre-commit-config.yaml
|
||||
repos:
|
||||
- repo: https://github.com/astral-sh/ruff-pre-commit
|
||||
rev: v0.5.0
|
||||
hooks: [{ id: ruff, args: [--fix] }]
|
||||
- repo: local
|
||||
hooks:
|
||||
- id: complexity-check
|
||||
entry: radon cc -n C src/
|
||||
language: system
|
||||
```
|
||||
|
||||
### 매 TODO/FIXME 의 ticket 의 promote
|
||||
```bash
|
||||
# 매 grep 의 FIXME 의 collect → 매 issue tracker 의 file
|
||||
rg -n "FIXME|HACK|XXX" --json | jq -r '.data.lines.text'
|
||||
```
|
||||
|
||||
## 매 결정 기준
|
||||
| 상황 | Approach |
|
||||
|---|---|
|
||||
| 매 typo · rename · dead code | 매 fix on sight |
|
||||
| 매 architectural smell | Ticket 의 file — 매 separate effort |
|
||||
| 매 PR 매 already large | Cleanup 의 follow-up PR 의 defer |
|
||||
| 매 hot path performance | Benchmark first — 매 cleanup 의 not change behavior 의 verify |
|
||||
| 매 legacy code 의 untested | Test 의 add first → 매 then refactor |
|
||||
|
||||
**기본값**: 매 touch 했으면 매 5분 cleanup 의 add — 매 separate commit, 매 PR description 의 mention.
|
||||
|
||||
## 🔗 Graph
|
||||
- 부모: [[Clean_Code]] · [[Software_Craftsmanship]]
|
||||
- 변형: [[Opportunistic_Refactoring]] · [[Continuous_Improvement]]
|
||||
- 응용: [[Refactoring]] · [[Code_Review]] · [[Technical_Debt]]
|
||||
- Adjacent: [[YAGNI]] · [[Single_Responsibility]] · [[Kaizen]]
|
||||
|
||||
## 🤖 LLM 활용
|
||||
**언제**: 매 file 의 read 한 후 매 "이 file 의 small improvement 5개 의 suggest" — 매 LLM 의 human eye 보다 빠르게 spot.
|
||||
**언제 X**: 매 critical path · 매 high-stakes module — 매 unintended behavior change 의 risk.
|
||||
|
||||
## ❌ 안티패턴
|
||||
- **Big bang refactor**: 매 PR 매 unrelated cleanup × 50 — 매 review 의 impossible.
|
||||
- **Drive-by style change**: 매 team convention 의 무시 한 personal preference.
|
||||
- **Cleanup commit 매 mix**: 매 main change 와 cleanup 의 same commit — 매 git blame 의 noise.
|
||||
- **Test 의 break**: 매 cleanup 의 behavior 의 change — 매 test 의 guard.
|
||||
- **Scope creep**: 매 5분 cleanup 매 2시간 rabbit hole — stop · ticket · commit.
|
||||
|
||||
## 🧪 검증 / 중복
|
||||
- Verified (Robert C. Martin *Clean Code* ch1; Kent Beck *Tidy First?* 2024).
|
||||
- 신뢰도 A.
|
||||
|
||||
## 🕓 Changelog
|
||||
| 날짜 | 변경 |
|
||||
|---|---|
|
||||
| 2026-05-08 | Phase 1 |
|
||||
| 2026-05-10 | Manual cleanup — patterns, LLM-assisted refactor, anti-patterns |
|
||||
|
||||
Reference in New Issue
Block a user