깃헙 규칙 - 작업내용이 헛갈릴 때

 

✨ update: 해당 파일에 새로운 기능이 생김

 

* 예시: "로그인 기능에 비밀번호 찾기 기능을 추가했습니다."

* 설명: 기존에 있던 파일 (`user_auth.py`, `login.js` 등)에 새로운 기능이 추가되었을 때 사용합니다. 단순히 코드 몇 줄을 수정한 것이 아니라, 사용자에게 의미 있는 새로운 동작이나 편의성을 제공하는 변경일 경우에 적합해요. 마치 집에 새로운 가구를 들여놓거나, 앱에 새로운 버튼이 생기는 것과 비슷하다고 생각하시면 돼요.

 

🎉 add: 없던 파일을 생성함, 초기 세팅

 

* 예시 1: "새로운 사용자 정보 모델 (`user_model.py`)을 추가했습니다."

* 예시 2: "프로젝트 초기 설정을 위한 `package.json` 및 관련 파일을 생성했습니다."

* 설명: 프로젝트에 처음으로 파일을 만들거나, 프로젝트를 시작하기 위한 기본적인 설정 파일들을 추가했을 때 사용합니다. 텅 빈 방에 벽돌을 하나씩 쌓아 올리거나, 새로운 도구를 작업실에 처음 가져다 놓는 상황과 같아요.

 

🐛 bugfix: 버그 수정

 

* 예시: "로그인 시 아이디가 대소문자를 구분하던 버그를 수정했습니다."

* 설명: 코드에 있던 오류나 오작동을 해결했을 때 사용합니다. 마치 집 안의 고장난 부분을 수리하거나, 게임 속 캐릭터의 움직임 오류를 바로잡는 것과 같습니다. 사용자 경험을 개선하고 프로그램의 안정성을 높이는 중요한 작업이죠.

 

♻ refactor: 코드 리팩토링

 

* 예시: "가독성을 높이기 위해 로그인 관련 함수들을 클래스로 묶었습니다."

* 설명: 코드의 기능은 그대로 유지하면서 내부 구조나 스타일을 개선했을 때 사용합니다. 마치 건물의 외관은 그대로 두고 내부 배치를 효율적으로 바꾸거나, 글의 내용을 다듬어 가독성을 높이는 것과 같아요. 코드의 유지보수성을 높이고 잠재적인 버그를 예방하는 데 도움이 됩니다.

 

🩹 fix: 코드 수정

 

* 예시: "오타 수정: 'requierd' -> 'required'"

* 설명: 간단한 코드 수정이나 오타 수정 등 비교적 작은 규모의 변경에 사용합니다. 버그 수정(🐛 bugfix)보다는 사소한 문제를 해결하는 경우에 더 적합해요. 마치 문서의 오탈자를 수정하거나, 그림의 작은 부분을 수정하는 것과 비슷합니다.

 

🚚 move: 파일 옮김/정리

 

* 예시: "모델 관련 파일들을 `models` 디렉토리로 이동했습니다."

* 설명: 파일이나 디렉토리의 위치를 변경했을 때 사용합니다. 코드의 기능적인 변화는 없지만, 프로젝트의 구조를 개선하거나 파일을 논리적으로 분류하기 위해 사용돼요. 마치 방 안의 가구를 재배치하거나, 서류들을 폴더별로 정리하는 것과 같습니다.

 

🔥 del: 기능/파일을 삭제

 

* 예시: "더 이상 사용하지 않는 레거시 코드 관련 파일을 삭제했습니다."

* 설명: 더 이상 필요 없는 기능이나 파일을 프로젝트에서 완전히 제거했을 때 사용합니다. 마치 오래된 물건을 버리거나, 더 이상 사용하지 않는 방을 없애는 것과 같아요. 프로젝트를 깔끔하게 유지하고 불필요한 코드를 줄이는 데 도움이 됩니다.

 

🍻 test: 테스트 코드를 작성

 

* 예시: "로그인 기능에 대한 단위 테스트 코드를 추가했습니다."

* 설명: 작성한 코드의 동작을 검증하기 위한 테스트 코드를 새로 만들거나 수정했을 때 사용합니다. 마치 건물을 짓기 전에 설계도를 검토하거나, 음식을 만들기 전에 재료의 신선도를 확인하는 것과 같아요. 코드의 신뢰성을 높이고 예상치 못한 오류를 방지하는 데 중요한 역할을 합니다.

 

💄 style: css

 

* 예시: "로그인 페이지의 디자인을 개선했습니다 (CSS 변경)."

* 설명: 사용자 인터페이스의 스타일(CSS)과 관련된 변경이 있을 때 사용합니다. 기능적인 변화보다는 시각적인 요소나 사용자 경험 개선에 초점을 맞춘 변경일 경우에 적합해요. 마치 웹사이트의 옷을 갈아입히거나, 앱의 디자인 테마를 변경하는 것과 같습니다.

 

🙈 gitfix: .gitignore 수정

 

* 예시: ".gitignore 파일에 불필요한 빌드 결과 디렉토리를 추가하여 Git 추적에서 제외했습니다."

* 설명: Git이 추적하지 않아야 할 파일이나 디렉토리를 정의하는 `.gitignore` 파일을 수정했을 때 사용합니다. 마치 중요한 문서를 다른 사람에게 보여주지 않기 위해 숨기는 것과 같아요. 불필요한 파일들이 Git 저장소에 포함되는 것을 방지하여 저장소를 깔끔하게 유지하는 데 도움이 됩니다.

 

🔨 script: package.json 변경 (npm 설치 등)

 

* 예시: "새로운 라이브러리 (`axios`)를 프로젝트에 추가하기 위해 `package.json` 파일을 업데이트하고 `npm install`을 실행했습니다."

* 설명: 프로젝트의 의존성 관리 파일인 `package.json` (또는 `yarn.lock`, `pom.xml` 등)을 변경했을 때 사용합니다. 주로 새로운 라이브러리를 설치하거나, 빌드 스크립트를 수정하는 등의 작업이 이에 해당합니다. 마치 레시피에 새로운 재료를 추가하거나, 요리 과정을 변경하는 것과 같습니다.