<aside> 💡 각종 컨벤션들을 작성하는 공간입니다. 첫 회의를 통해 아래 내용에 대해 규칙을 설정해주세요. 단, 모든 항목을 다 세울 필요는 없으며, 중요하다고 생각되는 항목부터 우선적으로 논의하고 결정하시면 됩니다.

</aside>

기본 규칙

<aside> 💡

프로젝트 진행 시간

• 프로젝트 진행일
  • 월~목 : 오전 9시 ~ 오후 7시
  • 금 : 오전 9시 ~ 오후 6시
  • 점심시간 : 오전 11시 50분 ~ 오후 1시
• ZEP에서 상시 접속, 필요 시 음성/채팅으로 소통
• 중간 이탈 시 반드시 팀원에게 알림

스크럼 & 진행 공유

• 09:00
• 11:30
• 18:00
• 회의 세부 내용은 ‘회의 규칙’ 참고

작업 공유 & 품질 유지

• 에러, 버그, 막힌 점은 즉시 공유
• 다른 사람 코드 수정 시, 사전 공유 필수
• PR 전 최소 로컬 테스트 진행 </aside>

회의 규칙

<aside> 💡

• 회의 종류 & 시간
  • 09:00 → 데일리 스크럼 (어제 한 일 / 오늘 할 일 / 막힌 점)
  • 11:30 → 중간 점검 (진행 상황 공유, 우선순위 재조정)
  • 18:00 → 마무리 점검 (오늘 작업 내용 공유 & PR 제출)
• 회의 진행 방식
  • 시간 엄수
  • 카메라·마이크 ON (상황 불가 시 사전 알림)
  • 마무리 점검 직후 PR을 같이 제출
  • 마무리 점검 전 에러가 잡히지 않은 경우 해당일은 PR 제출 X </aside>

협업 컨벤션

<aside> 💡

협업 툴

• GitHub → 코드 버전 관리 (브랜치 전략, PR 규칙은 아래 GitHub 항목 참고)
• Notion → 회의록, 문서, 일정 관리
• ZEP → 실시간 모임, 화상 회의, 화면 공유
• Discord → 빠른 알림, 비공식 소통 </aside>

브랜치 전략

<aside> 💡

1. 기본 흐름

• main: 항상 배포 가능한 안정 버전 유지
• 새로운 작업은 main에서 브랜치 생성 → 작업 → main에 PR 후 머지

2. 브랜치 네이밍 규칙

• 접두사 + 작업명 형태로 작성

• 접두사 종류:

  • feat/ → 새로운 기능 추가
  • fix/ → 버그 수정
  • refactor/ → 코드 리팩토링 (기능 변경 없음)
  • docs/ → 문서 수정
  • style/ → 코드 포맷, 스타일 변경
  • chore/ → 빌드, 설정, 기타 잡일

• 예시:

  feat/login-api
  fix/user-profile-bug
  refactor/card-component
  

</aside>

PR & Issue Rule

<aside> 💡

1. Issue 규칙

• 작업 시작 전 해당 작업의 GitHub Issue 생성 (또는 기존 이슈 확인)
• 작업 시작 시 이슈 상태를 In Progress로 변경
• 작업 완료 후 Done 상태로 변경
• 커밋 시 반드시 이슈 번호 연동 (#이슈번호)

2. PR 규칙

• PR 생성 시간: 프로젝트 진행일 18:00 마무리 점검 시간에 팀원 모두 함께 진행
• PR 대상 브랜치: main </aside>

커밋 컨벤션

<aside> 💡

<작업 내용> (#이슈번호)

• 작업 내용: 간결하고 명확하게 (한 줄 요약)
• 이슈번호: 반드시 #와 함께 작성해 GitHub 이슈와 연결 </aside>

네이밍 컨벤션

<aside> 💡

변수

• 일반: camelCase
• 상수: UPPER_SNAKE_CASE
• 의미를 명확하게, 축약어 지양

함수

• camelCase
• 동사+목적어 (getUserData)
• 이벤트 핸들러: handle / on 접두사
• React 훅: use 접두사

클래스

• PascalCase
• 명사형, 역할이 명확하게 (UserService, CardRepository)
• 파일명과 동일하게 작성 (UserService.js → class UserService)

컴포넌트

• PascalCase
• 파일명과 동일하게 작성
• 스타일 전용 컴포넌트: Styled 접두사

파일

• 일반: camelCase
• 컴포넌트: PascalCase
• 기능 중심 명사형 (userService.js)
• 전역 설정/환경 파일: 대문자 (README.md)

폴더

• kebab-case
• 소문자, 단어 구분은 하이픈 (user-profile/) </aside>

코딩 컨벤션

<aside> <img src="notion://custom_emoji/418882ab-6cf7-4e45-966c-7b73942c52cb/20ebb64d-a380-80a7-8716-007a9d744758" alt="notion://custom_emoji/418882ab-6cf7-4e45-966c-7b73942c52cb/20ebb64d-a380-80a7-8716-007a9d744758" width="40px" />

</aside>

환경 설정 컨벤션

<aside> <img src="notion://custom_emoji/418882ab-6cf7-4e45-966c-7b73942c52cb/20ebb64d-a380-80a7-8716-007a9d744758" alt="notion://custom_emoji/418882ab-6cf7-4e45-966c-7b73942c52cb/20ebb64d-a380-80a7-8716-007a9d744758" width="40px" />

</aside>

프론트 폴더 구조 컨벤션