Files
my-amiibo-database/docs/convention.md

793 B

코딩 컨벤션

언어

  • 사용자 대면 문서·UI 텍스트: 프로젝트 기본은 한국어(필요 시 일본어 병기)
  • Git 커밋 메시지·docs/update.md 작업 이력: .ai-rules.md에 따름(커밋 제목 vYYYY.MM.DD-번호 형식 등)

코드 주석

  • JavaScript: JSDoc 형식 사용(프로젝트 .ai-rules.md 규칙)

네이밍 가이드

구분 권장
DOM 조작용 변수 camelCase (amiiboList, selectedFilters)
상수 맵 seriesNameMap 등 의미 있는 이름
HTML id 역할이 드러나게 (amiibo-list, resetFilter)

데이터

  • 아미보 마스터 데이터는 db/amiibo.db.js 단일 소스로 유지하고, 필드 추가 시 본 문서의 spec.md 스키마 표를 갱신할 것