그라운드 룰 - dev-FEFIVE/NadoCat GitHub Wiki

1. 생활규칙

• 매일 회고록 작성하기
• 평일 11시 매일매일 간단하게 할 일/어제 한 일 공유
• 룰을 정할 때 본인 제외 2명 동의 얻기
• 쉴 때는 각자 일정에 맞게 미리 말하고 쉬기

2. 코딩 컨벤션

• double quotes 사용
• 화살표 함수 사용
• space와 tab을 섞어서 사용하지 않기(들여쓰기는 space 2개 크기의 tab으로 통일)
• 한 줄에 하나의 문장만 허용하며, 문장 종료 시에는 반드시 세미콜론(;)을 사용
• 변수와 함수의 이름은 카멜 케이스를 사용
• ts 파일명은 카멜 케이스, tsx 파일과 Controller 파일명은 파스칼 케이스, 폴더명은 소문자로만 작성하기
• 전역변수를 사용하지 않기
• 배열의 요소중 하나라도 줄 바꿈이 있다면 배열 안의 요소는 일관되게 모두 줄 바꿈을 해주기
• 화살표 함수의 파라미터가 하나이면 괄호를 생략
• 변수 등을 조합해서 문자열을 생성하는 경우 템플릿 문자열을 이용
• 한 줄짜리 블록일 경우라도 {}를 생략하지 않으며 명확히 줄 바꿈 하여 사용
• 삼중 등호 연산자인 ===, !==만 사용
• return문 바로 위는 한 칸 비워 놓기
• 주석은 설명하려는 구문에 맞춰 들여쓰기
• 문장 끝에 주석을 작성할 경우, 한 줄 주석을 사용하며 공백을 추가
• 키워드, 연산자와 다른 코드 사이에 공백이 있어야 함
• 콤마 다음에 값이 올 경우 공백이 있어야 함

참고

• https://ui.toast.com/fe-guide/ko_CODING-CONVENTION

3. 커밋 컨벤션

• 태그: 제목 형태 (ex. Feat: "추가 로그인 함수”)

- Feat: 새로운 기능 추가
- Fix: 버그를 고친 경우
- Design: CSS 등 사용자 UI 디자인 변경
- Style: 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
- Refactor: 프로덕션 코드 리팩토링
- Comment: 필요한 주석 추가 및 변경
- Rename: 파일 혹은 폴더명을 수정하거나 옮기는 경우
- Remove: 파일을 삭제하는 작업만 수행한 경우
- Test: 테스트 추가, 테스트 리팩토링(프로덕션 코드 변경 없을때)
- Chore: 빌드 수정, 패키지 매니저 수정 등 기타 사항

4. 브랜치 전략

main → develop → feature

• main: 가장 최신의 배포된 버전
• develop: 릴리즈 계획에 따라서 Github에서 기본 브랜치로 지정
• feature: 각 기능에 대한 브랜치. dev 브랜치에 병합

5. PR규칙

• 최대한 피드백 달아주기 (코드리뷰)
• PR 날린 본인이 승인, merge 하기
• 하루에 한번씩 PR 날리기
• PR rule -> _제목: 구현한 기능 _

// PR 제목 예시

- 작성사용자 이용 내역 저장
- 유저 이용내역 저장 및 전송