Git 골든 룰

Source: Dev.to

Git 저장소가 깨지는 것을 방지하기 위한 골든 규칙

골든 규칙 1: 절대 강제 푸시 하지 않기

• git push -f 또는 git push --force 사용을 피하세요. 다른 개발자의 변경 사항을 덮어쓰고 충돌을 일으킬 수 있습니다.
• 대신 일반적으로 푸시합니다. 예:

git push origin main   # 또는 원격 브랜치 이름

골든 규칙 2: 푸시하기 전에 항상 풀하기

푸시하기 전에 최신 변경 사항을 받아옵니다:

git pull origin main   # 또는 원격 브랜치 이름

골든 규칙 3: 브랜치를 정기적으로 병합하기

• 기능이나 버그 수정을 위해 별도의 브랜치를 만듭니다.
• 작업이 끝나면 메인 브랜치에 병합합니다:

git checkout main
git merge feature/new-feature

• 충돌을 해결한 뒤, 해결된 파일을 스테이징합니다:

git add 

골든 규칙 4: 병합 충돌을 신중히 해결하기

• git status, git diff 혹은 Meld와 같은 시각적 diff 도구를 사용해 충돌을 확인합니다.
• 충돌 파일을 직접 편집하고 git add 로 스테이징한 뒤, 충분히 테스트합니다.

골든 규칙 5: 커밋 전에 충분히 테스트하기

• 자동화 테스트를 실행하고, 수동 테스트를 수행하며, 코드 리뷰를 요청합니다.
• 깨지거나 미완성된 코드를 절대 커밋하지 마세요.

골든 규칙 6: 의미 있는 브랜치 이름과 설명 사용하기

• feature/add-login처럼 명확하고 설명적인 이름을 선택하고, 단순히 login 같은 이름은 피합니다.
• 어떤 변경을 했고 왜 했는지를 설명하는 간결한 커밋 메시지를 작성합니다.

골든 규칙 7: 커밋을 작고 집중되게 유지하기

• 거대한 커밋을 피하고, 큰 기능은 논리적인 작은 커밋들(가능하면 10줄 이하)로 나눕니다.

골든 규칙 8: 브랜치를 정기적으로 검토하고 정리하기

• 오래된 브랜치를 주기적으로 정리하고, 더 이상 필요 없는 브랜치는 삭제해 저장소를 깔끔하게 유지합니다.

병합 충돌 처리 추가 팁

• 문제 있는 병합 중단: git merge --abort
• 임시로 변경 사항 보관: git stash
• 팀원과 소통하여 충돌을 함께 해결하도록 합니다.

커뮤니케이션이 핵심

다른 사람이 작업 중인 브랜치에 푸시하면 팀에 알리세요:

1. 알림 받기 – 저장소 알림을 설정합니다.

2. 업데이트된 브랜치 풀하기:

   git pull origin 

3. 충돌 해결(있다면)하고 git add 로 수정 사항을 스테이징합니다.

4. 로컬 변경 사항을 최신 업데이트 위에 리베이스:

   git rebase origin/

5. 충분히 테스트하여 모든 것이 정상 작동하는지 확인합니다.

협업 개발을 위한 베스트 프랙티스

• 피처 브랜치를 사용해 작업을 격리합니다.
• 정기적으로 소통하여 어떤 브랜치에서 작업 중인지 공유합니다.
• 원격 저장소에서 자주 풀합니다.
• Git 훅을 활용해 코딩 표준 및 포맷을 강제합니다.

GitHub으로 알림 자동화하기

코드를 GitHub에 호스팅한다면 푸시 알림을 설정할 수 있습니다:

1. Repository Settings 로 이동합니다.
2. Notifications 를 클릭합니다.
3. 모니터링할 브랜치를 선택합니다.
4. 알림 유형(예: 푸시, 풀 리퀘스트)을 선택합니다.

이 규칙과 실천 방법을 따르면 안정적인 Git 저장소를 유지하고 보다 건강한 협업 환경을 조성할 수 있습니다.