Files
Pier_v1/.hmcmkit/knowledge/templates/convention.template.md
T
ahnyongjooandClaude Sonnet 5.5 964a841de1 chore(rebar): Pier_T_rebar 작업 폴더 초기 구성 및 외부 의존 파일 통합
- Code\rebar_pipeline, review_pipeline, pier-program을 정션에서 실제 폴더로 전환
- Code\rhino_mcp 및 CLAUDE_rhino배경.md 추가, .mcp.json은 PYTHONPATH로 새 위치 사용
- pier-program 내부 .git 제거(이력은 backup\pier-program_20261028.bundle에 보관)
- worktree 가이드 반영(CLAUDE.local.md, HANDOFF.md)
- D:\Rhino-MCP 경로 참조를 새 위치로 치환

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-28 11:20:18 +09:00

2.4 KiB

{{project_name}} Coding Conventions

PDCA Convention Document - 코드 작성 규칙 정의

Version: 1.0 Created: {{date}} Level: {{level}}


1. Naming Conventions

Files & Folders

Target Rule Example
Component files PascalCase UserProfile.tsx
Utility files camelCase formatDate.ts
Folders kebab-case user-profile/
Constants UPPER_SNAKE_CASE API_ENDPOINTS.ts

Code

Target Rule Example
Components PascalCase UserProfile
Functions camelCase getUserById()
Variables camelCase userName
Constants UPPER_SNAKE_CASE MAX_RETRY
Types/Interfaces PascalCase UserProfile

2. Folder Structure

src/
├── components/         # UI 컴포넌트
├── features/          # 기능별 모듈
├── hooks/             # Custom hooks
├── lib/               # 유틸리티
├── types/             # 타입 정의
└── styles/            # 스타일

3. Import Order

// 1. External libraries
import React from 'react'

// 2. Internal absolute (@/)
import { Button } from '@/components/ui'

// 3. Relative imports
import { useUser } from './hooks'

// 4. Type imports
import type { User } from '@/types'

// 5. Styles
import './styles.css'

4. Environment Variables

Naming Convention

Prefix Scope Example
NEXT_PUBLIC_ Client-side NEXT_PUBLIC_API_URL
DB_ Database DB_HOST, DB_PASSWORD
API_ API keys API_SECRET_KEY
AUTH_ Authentication AUTH_JWT_SECRET

Required Files

  • .env.local - 로컬 개발용
  • .env.example - 템플릿 (커밋)
  • lib/env.ts - 환경변수 검증

5. Code Style

  • Indentation: 2 spaces
  • Quotes: Single quotes (')
  • Semicolons: None (Prettier)
  • Max line length: 100

6. Commit Message

type(scope): description

Types: feat, fix, docs, style, refactor, test, chore

Validation Checklist

  • Naming convention 정의됨
  • Folder structure 정의됨
  • Import order 정의됨
  • Environment variables 정의됨
  • Code style 설정됨

Generated by hmcmkit PDCA System