Skip to content

MOAMOA Convention

TaeYoon edited this page Jul 20, 2022 · 6 revisions

Commit Convention

Git Commit Convention

  • angular commit convention을 따른다
  • [type]: [commit message]
    • ex) feat: login기능 구현
    • type종류: ['build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test']

Branch Name Convention

  • <type>/<issue-number>-<summary>
    • feat/6-new-calandar

Title Convention

PR Title

  • [<FE|BE|설정|문서>] issue<issue-number>: <issue에 적었던 작업 예정 내용>
    • [FE] issue42: 로그인 기능 추가

Issue Title

  • [<FE|BE|설정|문서>] <작업 예정 내용>
    • [FE] 로그인 기능 추가

기타 주의사항

  • Issue를 생성할때는 projects와 milestone을 지정해야하지만, PR은 이 둘을 지정하지 않도록 한다. 지정하면 Sprint에 Issue와 PR 두개가 나오기 때문이다
  • PR을 날릴때 Squash Merge를해서 해당 PR안에서 이루어진 commit내역을 하나로 묶는 commit을 생성한다. 어떤 일을 했는지 한눈에 알아볼 수 있기 때문이다
  • 주기적인 sync
    • upstream에 있는 변경사항을 local로 가져오고 -> fork한 origin remote repository에 push해서 작업전에 sync를 맞추도록 한다