✔️ Git Commit Convention

기능 단위 커밋

커밋은 기능단위로 할 것

Commit Message

type: Subject 형태로 작성하기(한글로)

ex) git commit -m "type: 세부내용”

Type

태그	설명
Feat	기능에 대한 commit
Fix	버그
Design	css, html
Style	로직 변경이 없는 코드 스타일 변경
Refactor	내부 로직의 변경이 있으나, 엔드포인트의 변경점이 없는 경우
Docs	문서
Directory	디렉토리의 내용만 수정

Subject

30자를 넘기지 말 것

✔️ GitLab branch 전략

FE, BE 각각 branch생성 → 기능별로 분리

• main: 제품으로 출시될 수 있는 브렌치.

• dev : 개발과정에서 fe/be의 코드를 모아 빌드하는 브렌치. 최선의 상태 유지.

• feature/기능명 : 해당 기능 구현을 진행할 때 사용하는 브렌치

  (Jira 스토리 기준으로 기능명 구분)

✔️ Jira 사용법

이슈생성

• 월요일에 주 단위 스프린트 이슈들을 생성
• 일주일에 40시간 이상 이슈 생성 및 처리

명명 규칙

• 작업
  • 대분류: 기획, DB, 개발, 배포
  • ex) [기획] 와이어 프레임 제작
  • ex) [개발] 회원 관리
• 작업
  • 개발+배포 [BE] [FE]
  • ex) [BE] 기능: 하위기능 - (세부기능) → [BE] 로그인: 토큰 - (세부내용)

✔️ FE 코딩 컨벤션

페이지 / 기능 단위로 폴더 생성, 하나의 파일에 하나의 컴포넌트

컴포넌트는 index.js에서 export

대상	케이스
컴포넌트 파일명	PascalCase
비 컴포넌트 파일명	camelCase
속성명, 변수명, 함수명	camelCase
unit test 파일명	파일명과 일치하게
ex) Login.js / Login.test.js
CSS 파일명	댓아 컴포넌트명과 일치하게

✔️ BE 코딩 컨벤션

서론

• https://bestinu.tistory.com/64 링크를 참조한 인텔리제이 컨벤션을 적용한다.
• 아래 내용은 naver checkstyle로 명확히 정의되지 않은 컨벤션에 대해 정리한 내용이다.

java

타입	작성법	기타	예시
variable	carmelCase	명사+명사,전치사 + 명사	boardId
method	carmelCase	동사 + 명사	doSomething
클래스	PascalCase	명사+명사	RequestDto
상수	CAPITALS_WITH_UNDERSCORE	명사+명사, 전치사 + 명사	API_VERSION

• 모든 네임스페이스에 축약어 사용 금지 ex) idx -> index
• 가독성이 떨어지더라도 의미가 명확한 이름 사용 ex) cnt1 -> firstArrayCount
• import * 과 비슷한 형태의 라이브러리 주입은 금지

스프링

• controller, service, repository 의 명명규칙
  • action + 반환 데이터 이름
• action

패턴	단어
CREATE	Insert
READ	select
UPDATE	update
DELETE	delete

• 반환데이터 이름은 backend 서버에 저장되어있는 dto 이름양식을 따른다
• 플래그 형식의 method 작성시엔 위의 명명규칙 대신 is + (행위ed or 명사)로 작성한다
• controller method, service, mapper의 이름은 통일
• controller의 이름과 path는 통일
  • ex) @controller(value = "/board") public class BoardController
• path의 마지막엔 / 삽입 금지