---

description: "문서화 가이드라인"

Documentation Guidelines

JSDoc

복잡하거나 외부에서 사용하는 함수에만 JSDoc을 작성한다. 자명한 함수나 내부 구현 세부사항에는 불필요하다.

/**
 * 구독 날짜를 상대적인 문자열로 변환
 * @example formatRelativeDate('2024-01-01') // '1년 전'
 */
export function formatRelativeDate(dateStr: string): string { ... }

문서 업데이트

• 기능 추가/변경 시 README.md 업데이트
• 변경사항은 CHANGELOG.md에 기록 (changelog.md 규칙 참고)