Skip to content

Latest commit

 

History

History
83 lines (74 loc) · 2.29 KB

컨벤션.md

File metadata and controls

83 lines (74 loc) · 2.29 KB

컨벤션

Jira Notion에서 보기 : Link

BackendCode Convention Notion에서 보기 : Link

Git Notion에서 보기 : Link


Jira

  • story : 개발에 관련된 것
  • task : 개발 외 모든 것
  • 일주일 총 story point 40 권장
  • 개인 단위보다 프로젝트 기능 단위로이슈를 생성하고 할당

Git

  • 기본
    • 수정한 소스 파일만 add
    • feature branch는 develop에 PR 처리
    • develop branch 부터는 CI/CD 연결 후 빌드

  • BRANCH
    • master
      • 제품으로 출시될 수 있는 브랜치
    • release
      • 다음 출시 버전을 개발하는 브랜치
    • develop-[front/back]
      • 기능을 개발하는 브랜치
      • FE, BE, BC 크게 3개로 분류
        • FE/대분류/소분류
        • FE/ticket/list
        • BE/ticketing/book
      • 브랜치 이름은 기능명세서 기준
      • 소분류 작업 완료 시 대분류 머지 → 대분류 기능들 테스트 완료 시 FE or BE or BC 머지
    • docs
      • 문서 작업 등

  • COMMIT MESSAGE
    [Part] Tag: Subject
    
    • Part
      • FE, BE, DEV, DOCS
    • Tag
      • add : 기능 추가
      • modify : 기능 수정
      • fix : 버그 수정
      • refactor : 코드 리팩토링
      • docs : 문서 작업
      • design : 프론트 디자인 수정
    • Subject
      • 로그인 기능 추가, 게시글 작성 엔티티 수정, 멤버 컨트롤러 수정
    • [BE] add: 닉네임 중복체크 기능 추가
    • [FE] design: 글작성 페이지 디자인 수정

  • master → release → develop-[back/front] → 대분류 → 소분류

BackEend Code Convention

  • 폴더
    • controller
    • entity
    • dto
    • repository
    • service
    • config
    • exception

  • 파일명 : 파스칼
    • MemberService.java
    • BoardConroller.java

  • 메서드명, 변수명 : 카멜 케이스
    • addBoard, getParty
    • findItem, members, memberRepository

  • DB : 스네이크
    • member_status
    • date_time
    • kakao_id