Skip to content

Latest commit

 

History

History
77 lines (57 loc) · 3.24 KB

README.md

File metadata and controls

77 lines (57 loc) · 3.24 KB

MangoPlate FrontEnd

📚 STACKS

코드 리뷰

https://www.notion.so/e7d2fada37fa4dc88f11aeface38c092

커밋 컨벤션

Branch

  • develop: 프론트 개발 브랜치
  • feat/xxx: (xxx: 이슈번호나 구현기능) 기능 개발
  • ui/xxx (xxx: 이슈번호나 페이지 화면) ui 개발

개발 후 develop 브랜치에 pr 후 머지하기

Type

  • feat: 새로운 기능, 특징 추가
  • fix: 수정, 버그 수정
  • design: CSS 등 사용자 UI 디자인 변경
  • !BREAKING CHANGE: 커다란 API 변경의 경우
  • !HOTFIX: 급하게 치명적인 버그를 고쳐야하는 경우
  • style: 코드 포맷 변경, 세미 콜론 누락, 코드 수정이 없는 경우
  • refactor: 리프로덕션 코드, 리팩토링
  • comment: 필요한 주석 추가 및 변경
  • docs: 문서에 관련된 내용, 문서 수정
  • test: 테스트 코드, 리팩토링 테스트 코드 추가, Production Code(실제로 사용하는 코드) 변경 없음
  • chore: 빌드 업무 수정, 패키지 매니저 수정, 패키지 관리자 구성 등 업데이트, 실제 코드 변경 없음
  • rename: 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
  • remove: 파일을 삭제하는 작업만 수행한 경우

Title

  • 제목은 최대 50글자가 넘지 않도록 한다.
  • 마침표 및 특수기호는 사용하지 않는다. 끝에 점(.) 없음
  • 영어로 작성시 첫 글자를 대문자로 쓰지 않는다.
  • 영문으로 표기하는 경우 동사(원형)를 가장 앞에 둔다.
  • 제목은 개조식 구문으로 작성한다. (간결하고 요점적인 서술)

Body

  • 본문은 한 줄 당 72자 내로 작성한다.
  • 본문 내용은 양에 구애받지 않고 최대한 상세히 작성한다.
  • 본문 내용은 무엇을 변경했는지 또는 왜 변경했는지를 설명한다. (변화에 대한 동기를 포함하고 이전 행동과 대조되어야 함)
  • 현재시제를 사용한다.

Footer

유형: #이슈 번호 형식으로 사용한다.

여러 개의 이슈 번호를 적을 때는 쉼표(,)로 구분한다.이슈 트래커 유형은 다음 중 하나를 사용한다.

  • Fixes: 이슈 수정중 (아직 해결되지 않은 경우)
  • Resolves: 이슈를 해결했을 때 사용
  • Ref: 참고할 이슈가 있을 때 사용
  • Related to: 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)

종료된 버그는 다음과 같이 Close 키워드가 붙은footer의 별도 줄에 나열되어야 한다.

여러 문제가 있을 경우 마찬가지로 쉼표(,)로 구분한다.Closes #123, #245, #992

프론트엔드 개발

  • @OhHyukJun
  • @LEEHYEYEONG
  • @snowooden