Git | 📝 개발 컨벤션, 컨벤션의 중요성, 레포 내 컨벤션 만들기

일단 convention이 왜 중요한가

사실 난 그동안 혼자서만 개발 공부를 해봤고 이럴 때 코드 컨벤션, 깃/커밋 컨벤션이 중요하다고 생각한 적이 없었다. 커밋 메세지를 작성할 때도 걍 대충 "first init".., "add" 이딴 것만 적었기 때문이지.
하지만 시간이 지난 상태에서 해당 내용을 다시 보면 내가 작성했을 지라도 이게 뭔 소린가 싶은 적이 많았다.

만약 동료들과 함께 프로젝트를 진행하고 다른 사람이 이것을 이해해야하고 활용해야하는 상황이라면 상황은 더더욱 안 좋겠지... 각자의 스타일대로 작성하고, 이슈와 PR 을 공유하면 헷갈리고 복잡한 개발 환경이 될 것이다.

convention의 궁극적인 목표

결국 목표는 누구나 쉽게 코드를 이해하고 사용할 수 있게 하기 위해서이다. 깃에서는 커밋, 이슈, PR 등의 부분에서 사람들과 공유할 사항들에 대해 가독성을 높이기 위해서다. 규칙들을 통해 커밋 로그의 가독성을 높이고, 코드 유지보수를 더 용이하게 할 수 있다. 이렇게 적절한 컨벤션을 사용하면 더 나은 협업과 리뷰 프로세스가 가능해질 것이다 ㅎㅅㅎ
코드 컨벤션의 경우에도 역시 좋은 변수명, 메소드 명 (네이밍 컨벤션)을 설정해주는 것이 좋다.

Commit convention

보통의 커밋 컨벤션 구조

git commit -m "커밋메세지"

이 때 이 "커밋메세지" 부분을 정한 양식에 맞게 작성하는 것이 커밋 컨벤션 이라고 말할 수 있다.

일종의 형식이 존재하는 거 같은데, 일단 내가 쓸 레포 내 커밋 컨벤션으로는 아직 의미가 없다고 생각해서 대충 정해보았다 !

Shoveling 내 나만의 작은 컨벤션 (나작컨...)

Commit Convention

• 코딩테스트 문제풀이의 경우

[문제풀이 사이트][레벨 및 문제지] 문제 [(문제이름)] 풀이

ex) Programmers Lv.0 Day3 문제 (최빈값 구하기) 풀이

음... 아직 코테 문풀 말고 커밋 해본 적이 없네 나중에 추가해야겠다.

PR

🔨 현재 PR 사항

🔨 To Do

🙏 To Reviewer

ETC

예시)

🔨 현재 PR 사항

• #22 과제 해결

🔨 To Do

• PR 템플릿 생성
• issue 템플릿 생성 (Coding-test, BUG, FEATURE)

🙏 To Reviewer

흠,,,

ETC

+) 이슈 컨벤션 추가

이슈 템플릿을 만들면서 몇가지를 더 추가해본다!

✏️ 문제지

✏️ 풀이한 문제
-[ ]
-[ ]
✏️ ETC
사진 첨부

브랜치 명

소문자로 작성
spacing 필요한 경우 - 기호 추가

예시) back-study , coding-test