파일명

• 주 (Python): 스네이크 케이스
  • 예시: vm_manager.py, audit_logger.py, crypto_utils.py
• 부 (HTML, CSS, JS): 스네이크 케이스
  • 예시: dashboard.html, common.css, dashboard.js

Git 커밋

• (ADD|FIX|DEL|STYLE) : [커밋 제목]

[커밋 상세 설명]

• ADD - 기능 추가 / FIX - 기능 수정 / DEL - 기능 삭제 STYLE - 코드 외의 파일 수정 (README, .env 등)

코드 주석

• Python Docstring으로 작성

• 함수 단위 필수, 설명이 필요한 경우 상세 작성

  • 예시:

  def create_vm(db: Session, owner_id: int, ip: str):
   """
   새로운 가상머신 정보를 DB에 기록합니다.
   Args:
   db: SQLAlchemy 세션
   owner_id: 소유자 ID
   ip: 할당할 IP 주소
   Returns:
   생성된 VM 객체
   """
  

파일 내 네이밍

• HTML class 속성: 케밥 케이스
  • 예시: forge-card, vm-item, status-badge
• HTML id 속성: 케밥 케이스
  • 예시: vm-list, os-select, btn-forge
• data- 속성*: 케밥 케이스
  • 예시: data-id, data-terminal
• Python 함수명: 스네이크 케이스, 소문자 시작
  • 예시: get_current_user(), create_vm()
• Python 변수명: 스네이크 케이스
  • 예시: owner_id,db_vm
• Python 상수명: 대문자 스네이크 케이스
  • 예시: MAX_VM_PER_USER, ALLOWED_ACTIONS
• JavaScript 함수·변수명: 카멜 케이스
  • 예시: controlVM(), syncStatus(), isLoggedIn
• JavaScript 상수명: 대문자 스네이크 케이스
  • 예시: VM_ID, MAX_RETRY

Redis 키 네이밍

• 구분자: : (콜론) 고정