Skip to content

Team Dreamer

chochohee edited this page Dec 21, 2024 · 5 revisions

⌨ 컨벤션

1. Git 컨벤션

1-1 Commit 메시지

  • 깃모지 사용 : commit 유형에 따라 아래 표에 따라 이모지를 사용합니다.
icon code 설명 원문
🎉 tada 프로젝트 시작 Begin a project
📝 memo 문서추가/수정(마크업) Add or update documentation.
💄 lipstick UI/스타일 파일 추가/수정(CSS) Add or update the UI and style files.
sparkles 새 기능(JS) Introduce new features.
🎨 art 코드의 구조/형태 개선(JS 수정) Improve structure / format of the code.
🔥 fire 코드/파일 삭제 Remove code or files.
💡 bulb 주석 추가/수정/삭제 Add or update comments in source code.
🐛 bug 버그 수정 Fix a bug.
🚚 truck 파일 및 폴더 이동, 이름 변경 Move or rename resources(e.g..:files paths routes).
🔀 twisted_rightwards_arrows GIT 브랜치 합병 Merge branches.
rewind GIT 변경 내용 되돌리기 Revert changes.
zap [QA/QC] 성능 개선 Improve performance.
♻️ recycle [QA/QC] 코드 리팩토링 Refactor code.
  • commit 메시지 작성 규칙
    1. 메시지는 한 줄로 간결하고 명확하게 작성.
    2. 가능한 작업 단위로 세분화하여 커밋.
    3. 관련 작업이 있을 경우 이슈 번호를 함께 기재.

1-2. Merge 규칙

  • 팀원들과 협력하여 Merge 진행
  • Merge 고정일 : 매주 월,수,금 (주 3회 진행)
    • 월요일은 오전 데일리 스크럼시간, 수,금은 오후 시간에 진행합니다.
    • 단, 작업 속도 및 양에 따라 유동적으로 변경될 수 있습니다. (회의를 통해 결정)

2. 코드 컨벤션

2-1. 컴포넌트 및 파일/폴더 네이밍

  • 컴포넌트명 : PascalCase (예: Header, Profile)
  • 폴더명 : camelCase (예: components,hooks)
  • 함수 및 변수명: camelCase(예: handleSubmit,openModal)
  • 마크업 클래스명: kebab-case(예: header-title,submit-btn)

2-2. CSS 작성 규칙

  • 각 컴퓨넌트에 대응되는 CSS 모듈 파일을 사용.
    • 컴포넌트 파일과 CSS 모듈 파일은 동일한 이름으로 작성.
      • 예: HeaderHeader.module.css