git - 커밋 가이드라인

2022. 12. 11. 23:45기타 팁

728x90

<커밋 메시지에 대한 주의사항>

1. 공백문자를 깨끗하게 정리하고 커밋해야 한다.

커밋을 하기 전에 

git diff --check 명령으로 공백문자에 대한 오류를 확인할 수 있다.

커밋을 하기 전에 공백문자에 대해 검사를 하면 공백으로 불필요하게 커밋되는 것을 막고 

이런 커밋으로 인해 불필요하게 다른 개발자들이 신경 쓰는 일을 방지할 수 있다.

 

2. 최대한 수정사항을 한 주제로 요약할 수 있어야 하고 

여러가지 이슈에 대한 수정사항을 하나의 커밋에 담지 않아야 한다.

한 커밋에 이슈 하나만 담기도록

같은 파일의 다른 부분을 수정하는 경우에는 

git add --patch 또는 git add -p 명령으로 한 부분씩 나누어 Staging Area에 저장해야 한다.

여러 번 나누어 커밋하는 것이 다른 동료가 수정한 부분을 확인할 때나 

각 커밋의 시점으로 복원해서 검토할 때 이해하기 훨씬 쉽다.

 

3. 커밋 메시지 자체를 신경쓰자

"테스트를 추가함" 보다는 "테스트 추가" 와 같이 현재형 표현 또는 명령문이 좋다.


* 내가 작업중인 토픽 브랜치에서의 작업을 마치고 서버와 어떤 내용이 Merge 되는지 

확인하는 명령 : git log --no -merges topicbranch..origin/master

-> 뒤의 브랜치(origin/master)에 속한 커밋 중 앞의 브랜치(topicbranch)에 속하지 않은 커밋을 검색하는 문법

 

* git push -u origin featureB:featureBee 명령:

서버에 있는 featureBee 브랜치로 내 로컬 브랜치 featureB 푸시

 


<공개 프로젝트 Fork>

“Fork” 버튼을 누르면 원래 프로젝트 저장소에서 갈라져 나온, 쓰기 권한이 있는 저장소가 하나 만들어진다.

-> 그 저장소를 로컬 저장소의 리모트 저장소로 등록해서 로컬에서 수정한다.

-> Fork 한 저장소에 Push 하고 나면 프로젝트 관리자에게 이 내용을 알려야 한다. 이것을 Pull Request 라고 한다. 

(호스팅 사이트에서 관리자에게 보낼 메시지를 생성하거나 git request-pull 명령으로 이메일을 수동으로 만들 수
있다. GitHub의 “Pull Request” 버튼은 자동으로 메시지를 만들어 준다)

 

728x90

'기타 팁' 카테고리의 다른 글

인텔리제이 단축키  (0) 2023.04.27
git - 분산 환경에서의 워크플로  (1) 2022.12.11
git 브랜치 워크플로  (0) 2022.12.11
GIT 브랜치  (0) 2022.12.11
캡처도구 없이 단축키만으로 화면 캡처하기  (0) 2022.11.26