Git Commit & PR Convention

이 페이지는 협업을 위한 Git 사용 Convention에 대해 설명합니다.

작업을 시작할때는 먼저 Assigned된 Issue를 위한 작업 브랜치를 생성합니다. 하나의 이슈는 하나의 작업 브랜치를 가지게 됩니다. 이때 작업 브랜치는 Issue의 번호를 따 이름의 prefix로 가집니다.

[Branch 생성 명령어]
git checkout -b issue-[ISSUE_NUMBER]/[issue_description]
e.g.
git checkout -b issue-14/add_text_serializer

작업이 일정 정도 완료되면 커밋을 남길 수 있습니다. 이때 브랜치의 커밋의 수와 메세지에는 따로 제한을 두지 않습니다. 편한 대로 작성해 주시면 됩니다.

[현재까지의 변경 사항 저장 & 커밋]
e.g.
git add . <--프로젝트 Root에서 입력
git commit "add font field to theme provider"

브랜치에서 작업이 끝나면 Pull Request를 오픈해야 합니다. 작업 브랜치는 항상 Develop 브랜치에 Merge하는 방향으로 오픈되어야 합니다. 오픈된 Pull Request가 Merge 되기 위해서는 Branch Rule에 따라 다른 동료들로부터 일정 수의 Approval를 필요로 합니다.

Pull Request를 오픈하면 제목과 설명을 적습니다. 내용에 따로 제한은 없으나 관련된 Issue로 부터 Acceptance Criteria에 관련된 내용을 가져와 주시면 좋습니다. 리뷰가 편해지니까요.

오픈한 Pull Request 오른쪽 아래에 Development 섹션이 있습니다. 톱니바퀴 모양을 클릭하여 Pull Request에 연결할 Issue를 찾아 연결해주셔야 합니다.
(Auto Linking이 작동을 안해서 수동으로 연결해줘야 합니다ㅠ)

Pull Request가 일정 수의 Approval을 받았다면 Develop Branch에 Merge 해주시면 됩니다.