GitHub 제대로 쓰기

Commit Convention (유다시티 컨벤션으로 설명)

- Commit을 남기는 규칙

- Commit Log를 통해 서로 다른 사람들이 내용을 파악하고 유지보수

- Modern Commit Convention은 Header, Body, Footer로 구성

Header

- Commit Log의 제목을 나타내는 부분

- 일반적으로 Tag가 붙음 (Prefix)

- feat, refactor, fix, style, chore, tests, docs 등

- 굳이 영어 X

Body

- 상세 기록을 나타내는 본문

- Header에서 한줄로 설명이 가능한 수준이라면 생략 가능

Footer

- 관련 Issue의 Tag가 붙음

- Github에서 자동으로 해당 태그를 인식

- Issue Tag는 #{Issue 번호}

Pre-commit

- git commit 명령어를 수행할 때 정해진 스크립트들을 실행하는 툴

 

Issue

- 개발 작업 단위

- History 관리를 위해 작성하는 것이 좋음

- Commit convention처럼 Tag를 붙임

- [FEAT], [BUG], [REFACTOR]

Issue Template

- 대표적으로 Feature Request / Bug Report 등이 있음

- Setting에서 등록 할 수 있으며, 실제로는 .github 경로에 추가

 

Pull Request (PR)

- Merge 작업 전에 팀원에게 코드 리뷰를 받는 단계

- Overview, Cange Log, To Reviewer, Issue Tag를 기록

- Reviewer, Assignee를 반드시 지정

- Files Changed 탭을 클릭해 진행 가능

- 코드 왼편 숫자에서 코멘트를 남기고 리뷰 시작 가능

- Approve를 받은 경우 Merge 가능

- Create a merge commit, Squash and merge, Rebase and merge

PR Template

- Issue Tag에 특정 키워드를 적는 경우 해당 PR이 Defalult branch에  Merge될 때 Issue가 자동으로 닫히도록 가능

- Issue Template과 다르게 ,github 경로에 .md 파일을 직접 추가