🤝Convention

📋JIRA Convention

작업유형 Convention

• Epic
  해당 이슈을 포괄하는 큰 단위의 업무
• Story
  Epic을 수행하기 위한 main 업무
• Sub-task
  Story를 수행하기 위한 부작업
• Task
  Epic을 수행하기 위한 sub 업무(문서작업, 조사, 학습 등)

🦊 Git Convention

Git Flow - 기존의 git flow 방식을 유지

Main branch

• master 배포 가능한 상태만을 관리 안정된 상태
• develop 통합 브랜치의 역할, 평소 develop 브랜치를 기반으로 개발 진행

Feature branch

• 새로운 기능 개발 및 버그 수정이 필요할 때, develop 브랜치로부터 분기
• 개발이 완료되면 develop 브랜치로 병합하여 다른 사람들과 공유

Release branch

• 버그를 수정하거나 새로운 기능을 포함한 상태로 모든 기능이 정상적으로 동작하는지 확인
• 릴리즈를 위한 최종적인 버그 수정 등의 개발을 수행 후 배포 가능한 상태가 되면 master 브랜치에 병합
• 버그 사항 수정은 develop 브랜치에도 적용해야 하기 때문에, 병합 작업 수행

Hotfix branch

• 배포한 버전에 긴급하게 수정을 해야 할 필요가 있을 경우 master 브랜치에서 분기하는 브랜치
• master에서 분기하는 이유 배포한 소스코드에 큰 버그가 발생시, develop에서 수정 후 배포가능한 버전을 만들기에는 시간도 많이 소요되고, 안정성을 보장하기 어려움 ⇒ 안정성이 보장된 바로 배포가 가능한 master 브랜치에서 분기
• 버그 사항 수정 후 , develop에도 병합하여 버그 수정 사항 반영

Commit

• commit convention : [이슈 번호] 기능 분류 : 상세설명(한글)
• git cz 사용

🦦 MariaDB Convention

DB 네이밍 규칙 : 🐍snake_case

(한 문자 단어마다 _(언더바)를 붙여서 의미를 부여하는 방식)

1. Table 명 : {table명} ex. users
2. Column 명 : {table명}_{column의미} ex.user_uid, user_name, user_email, user_password
3. 약어를 지양하고 풀네임을 사용!!
4. 가능한 예약어는 피하는 것으로!! https://dev.mysql.com/doc/refman/5.7/en/keywords.html
5. 복수형 사용 : 테이블 명
6. 단수형 사용 : 컬럼명 등
7. PRIMARY KEY : auto increment의 경우 _seq 접미어를 사용한다.
8. FOREIGN KEY : 자식컬럼 이름 앞에 fk_ 접두어를 사용한다.
9. boolean 유형의 컬럼이면 _flag 접미어를 사용한다.
10. date, datetime 유형의 컬럼이면 _date 접미어를 사용한다.

🌱 Spring Boot Convention

• 클래스 및 인터페이스 이름 : Pascal Case

  1. 이름 첫 번째는 대문자로 시작
  2. 축약형은 사용하지 않음
  3. DB Table 이름을 기반으로 ex. ChallengeController, UserController, ChallengeRepository, ChallengeService
  4. 인터페이스를 상속받는 클래스 이름 : 인터페이스 이름 + Impl
     ex. 클래스 이름 : UserServiceImpl / 인터페이스 이름 : UserService

• Method 및 변수 이름 : camel Case

  1. 이름 첫 번째 글자는 소문자
  2. 축약형은 사용하지 않음