Files
2nd/10_Wiki/Topics/AI_and_ML/Development Communication Standards.md
T

4.1 KiB

id, title, category, status, canonical_id, aliases, duplicate_of, source_trust_level, confidence_score, tags, raw_sources, last_reinforced, github_commit, inferred_by, tech_stack
id title category status canonical_id aliases duplicate_of source_trust_level confidence_score tags raw_sources last_reinforced github_commit inferred_by tech_stack
wiki-2026-0508-development-communication-standa Development Communication Standards 10_Wiki/Topics needs_review self
P-REINFORCE-AUTO-WIKI-DEV-005
none A 0.95
development
communication
conventional-commits
conventional-comments
standardization
p-reinforce
2026-05-01 pending Claude Opus 4.7 (auto-normalize 2026-05-08)
language framework
unspecified unspecified

Development Communication Standards (Conventional Commits & Comments

📌 한 줄 통찰 (The Karpathy Summary)

"코드와 피드백의 의도를 라벨링하여 인간 간의 오해를 줄이고 기계적 처리를 가능하게 하는 텍스트 표준화 전략: 명확한 소통이 개발 속도와 심리적 안전감을 결정한다."

📖 구조화된 지식 (Synthesized Content)

개발 과정에서 발생하는 텍스트 기반 소통을 규격화하여 협업 효율을 극대화합니다.

  1. Conventional Commits:
    • 커밋 메시지에 유형(예: feat:, fix:, chore:, refactor:)을 명시합니다.
    • 자동화된 릴리스 노트 생성과 버전 관리(Semantic Versioning)의 기반이 됩니다.
  2. Conventional Comments:
    • 코드 리뷰 시 코멘트 앞에 라벨(예: suggestion:, issue:, nitpicked:, praise:)을 붙입니다.
    • Decorations: (blocking) vs (non-blocking)을 통해 즉각적인 수정 필요 여부를 명시하여 작성자의 혼란을 제거합니다.
  3. 심리적 안전감과 효율성:
    • 라벨링은 피드백을 '공격'이 아닌 '객관적 분류'로 인지하게 도와주며, 사소한 트집(Nitpicking)에 낭비되는 시간을 줄여줍니다.

⚠️ 모순 및 업데이트 (Contradictions & Updates)

  • 과도한 형식주의: 형식 준수에 매몰되어 본질적인 피드백의 질이 떨어지는 것을 경계해야 합니다. 도구(브라우저 확장 등)를 활용하여 형식 입력의 마찰을 최소화하는 것이 중요합니다.
  • 자동화와의 병행: nit:(사소한 스타일) 코멘트가 많아지면 중요한 로직 피드백이 가려질 수 있습니다. 스타일 이슈는 린터가, 비즈니스 로직은 인간이 담당하는 역할 분담이 전제되어야 합니다.

🔗 지식 연결 (Graph)


🤖 LLM 활용 힌트 (How to Use This Knowledge)

언제 이 지식을 쓰는가:

  • (TODO)

언제 쓰면 안 되는가:

  • (TODO)

🧪 검증 상태 (Validation)

  • 정보 상태: needs_review
  • 출처 신뢰도: A
  • 검토 이유: (P-Reinforce Phase 1 자동 정규화. 본문 검증 필요.)

🧬 중복 검사 (Duplicate Check)

  • 기존 유사 문서: (TODO: 인덱서 클러스터 리포트 참조)
  • 처리 방식: UPDATE (자동 정규화)
  • 처리 이유: Phase 1 정규화 — 옛 템플릿/누락 필드 보강.

🕓 변경 이력 (Changelog)

날짜 변경 내용 처리 방식 신뢰도
2026-05-08 P-Reinforce Phase 1 정규화 (frontmatter + 헤더 표준화) UPDATE A

💻 코드 패턴 (Code Patterns)

패턴 1: (TODO: 이 프로젝트 컨벤션 반영한 구조 스켈레톤)

# TODO

🤔 의사결정 기준 (Decision Criteria)

선택 A를 써야 할 때:

  • (TODO)

선택 B를 써야 할 때:

  • (TODO)

기본값:

(TODO)

안티패턴 (Anti-Patterns)

  • [안티패턴]: (TODO: 무엇을 하면 안 되는가 + 이유 + 대신 무엇을)