Git 협업을 위한 브랜치 네이밍 규칙

Naming Convention이란?

Naming Convention(네이밍 컨벤션)은 코드에서 변수, 함수, 클래스, 파일 이름 등을 일관되게 작성하기 위해 정해진 규칙을 의미합니다. 이는 코드의 가독성을 높이고, 팀 내에서 일관된 스타일을 유지하여 협업을 원활하게 합니다. 이런 네이밍 규칙은 Branch Naming에도 필요합니다.

 

Git Branch Naming Convention

Git에서 브랜치를 관리할 때도 명확하고 일관된 네이밍 컨벤션을 따르는 것이 중요합니다. 대표적인 브랜치 네이밍 규칙은 다음과 같습니다.

 

1. feature/브랜치명

• 예시: feature/sign-in, feature/sign-up

• 새로운 기능을 개발할 때 사용하는 브랜치 이름입니다. feature/ 접두사를 붙여서 해당 브랜치가 기능 개발용임을 명확히 합니다.

 

2. bugfix/브랜치명

• 예시: bugfix/login-error, bugfix/header-layout

• 버그를 수정할 때 사용하는 브랜치 이름입니다. bugfix/ 접두사를 사용하여 수정 중인 버그임을 표시합니다.

 

3. hotfix/브랜치명

• 예시: hotfix/critical-bug, hotfix/security-patch

• 프로덕션에서 발생한 긴급한 문제를 수정할 때 사용하는 브랜치 이름입니다. hotfix/ 접두사를 사용합니다.

 

4. release/브랜치명

• 예시: release/v1.0.0, release/v2.1.0

• 릴리즈 준비를 위해 사용하는 브랜치 이름입니다. release/ 접두사를 붙여 릴리즈 작업용임을 명확히 합니다.

 

5. chore/브랜치명

• 예시: chore/update-dependencies, chore/cleanup-code

• 코드 정리, 의존성 업데이트 등 기능 개발과는 직접 관련이 없는 작업을 할 때 사용하는 브랜치 이름입니다. chore/ 접두사를 사용합니다.

 

6. 언더스코어(_)와 하이픈(-) 사용

브랜치 이름에서 언더스코어(_)와 하이픈(-)의 사용은 팀 내에서 미리 정의된 규칙에 따라 사용됩니다. 일반적으로:

• 하이픈(-): 단어 간의 구분을 위해 주로 사용됩니다. 예: feature/user-authentication

• 언더스코어(_): 하이픈과 마찬가지로 단어를 구분할 때 사용되지만, 팀의 스타일에 따라 선택됩니다. 예: feature/user_authentication

결론은, Naming Convention과 Naming Rule을 잘 지키는 것은 코드의 품질을 높이고 협업을 원활하게 만드는 중요한 요소입니다.