[Docs] Git Commit 컨벤션 & Git Flow 문서 작업

[coldrain-f]

Description

기존 개인 프로젝트에서 새로운 팀원 합류로 Git Commit 컨벤션과 Git Flow 규칙을 정할 필요성이 생겼기 때문에 관련 주제로 팀 미팅 및 문서 작업 필요.

+231030 회의 결과 컨벤션은 같이 협의하는 게 가장 좋지만, 시간을 맞추기가 어렵기 때문에 업무를 분담하고 이슈 댓글로 틈틈이 논의하기로 결정

Works

• [x] Commit 컨벤션 관련 팀 미팅 @Ksinny @coldrain-f
• [x] Commit 컨벤션 문서 작업(README.md) @Ksinny
• [x] Git Flow 관련 팀 미팅 @Ksinny @coldrain-f
• [x] Gie Flow 문서 작업(README.md) @Ksinny

References

• Git - 커밋 메시지 컨벤션
• 올바른 커밋 남기기 (Refactor vs. Fix)
• 협업을 위한 기본적인 git 커밋컨벤션 설정하기

[Ksinny]

Whale-Voca 에서 사용할 Commit Convention에 대해 정리했습니다. Commit 컨벤션 정리 Notion

[coldrain-f]

@Ksinny

이슈는 Description이나 Works와 같은 포맷을 포함하도록 저번 회의 때 정했지만, 댓글(이슈 코멘트)은 포맷을 따로 달지 않는 게 괜찮을 것 같습니다.

[coldrain-f]

@Ksinny

정리하신 내용 읽어봤습니다. docs랑 update가 각각 문서 수정, 문서 개정이던데 어떤 차이를 생각하신 건가요? refactor의 예시도 파일/폴더 이름 및 위치 변경으로 되어있던데 rename과 refactor의 차이점이 궁금합니다.

[Ksinny]

@coldrain-f

피드백 감사합니다. 추후 댓글 수정하겠습니다.

docs는 보편적으로 사용되는 Type에서의 문서 수정을 채택하였고, update는 버전 업데이트나 기능 추가에 있어서 문서의 내용을 수정해야할 경우를 문서 개정으로 표현했습니다.

"파일/폴더 이름 및 위치 변경"은 문서 내 애매한 표현으로 혼란을 드린 것 같습니다. Whale-Voca의 Commit 내역을 검토하였는데, 같은 기능을 수행하는 것 같아 보이지만 다른 Type으로 Commit Message가 작성된 부분이 있어서 어떤 기준으로 사용된 것인지 회의를 거친 후에 1안, 2안, 3안 중 채택하면 좋을 것 같아서 작성해두었습니다.

[Ksinny]

Git Branch 전략에 대해 알아보고 정리하고, 어떤 전략을 채택할지에 대해 고민해보았습니다. 어떤 flow로 Branch를 이용할 지 대략적으로 흐름을 정리했습니다. Git Branch 전략

도메인형과 계층형 중 어떤 패키지 구조를 이용할 지 고민하다가 우선 도메인형 구조를 채택했습니다. 현재 프로젝트 이해도가 높지 않아서 이 부분에서 고민하는데에 많은 시간을 소요했고, 정확한 패키지 구조를 생각하기엔 어려움이 있었습니다. 대략적으로만 작성해두었고, 회의 이후 다시 수정해보겠습니다. 패키지 구조

[coldrain-f]

+20231101(수) 회의 후 Git Branch 전략 및 Commit Convention 결정 완료

[Ksinny]

1) Git Commit Convention은 rename, design, update 타입을 제외하였고, 각 타입의 대략적인 범위를 확립했습니다.

2) Git Branch 전략에 대해서는 기존에 제안했던 Git Branch 전략 을 채택하였습니다.

3) 패키지 구조는 제안했던 도메인형이 아닌, 계층형 구조가 프로젝트에 더 적합하다고 판단하여 변경되었습니다.