내일배움캠프 Unity - TIL : 25.01.24

오늘 학습한 내용

1) Git 컨벤션 설정하기

• 팀원 간의 일관성 및 체계적인 작업을 위해 커밋 메시지와 브랜치 네이밍 규칙을 설정하기.
• 작업 내용을 쉽게 구분할 수 있도록 [기능], [수정], [버그]와 같은 팀원들과 미리 정한 규칙(태그)를 활용. (한글 유무 상관 없음)
  
  

2) Git에서 Main브랜치로 머지전에 Dev브랜치 사용

• Main 브랜치 안정성을 위해 Dev 브랜치를 중간 단계로 활용.
• 모든 변경 사항은 Dev 브랜치에서 테스트 후 Main 브랜치에 반영.
  
  

3) Readme 꾸미기

• 프로젝트 발표 자료처럼 README를 구성하여 주요 내용을 한눈에 파악할 수 있도록 정리.
• Markdown 기능을 활용해 와이어프레임, 트러블슈팅 등 시각적 자료를 포함.

---

문제 및 해결 과정

문제 (Git 컨벤션 설정하기)

튜터님의 피드백을 통해 팀원 간의 커밋 메시지와 브랜치 네이밍 규칙이 일관되지 않아 작업 내역 파악과 관리가 어렵다는 지적을 받았습니다.

 

시도한 해결 방법

• 커밋 메시지에 [기능], [수정], [버그] 등 팀원들과 사전에 합의한 규칙(태그)을 사용하는 컨벤션을 학습했습니다.
• 브랜치 네이밍 규칙으로 feature/기능명, bugfix/버그명 같은 형식을 활용하는 방법을 배웠습니다.

 

결과

팀원들의 작업 내역을 정확히 파악하고 체계적으로 관리할 수 있는 커밋 및 브랜치 컨벤션의 중요성을 이해하게 되었습니다.

 

 

문제 (Git에서 Main브랜치로 머지전에 Dev브랜치 사용하기)

Main 브랜치에서 바로 작업하거나 병합하다 보니 충돌 및 오류 가능성이 높다는 피드백을 받았습니다.

 

시도한 해결 방법

• Main 브랜치의 안정성을 확보하기 위해 Dev 브랜치를 중간 단계로 사용하는 방식의 필요성을 학습했습니다.
• Dev 브랜치에서 모든 변경 사항을 테스트한 후 Main 브랜치에 병합하는 절차를 배웠습니다.

 

결과

Main 브랜치의 안정성을 유지하면서 체계적으로 작업을 진행할 수 있는 방식에 대해 확실히 이해하게 되었습니다.

 

 

문제 (Readme 꾸미기)

README 파일이 간단한 기본 정보만 적혀있기 때문에 보고도 해당 프로젝트가 어떤 내용인지 쉽게 파악이 어렵다는 것을 인지했습니다.

 

시도한 해결 방법

Markdown을 활용해 Readme 파일에 프로젝트 설명, 주요 기능, 와이어프레임, 트러블슈팅 등을 포함시키고, 시각적 자료와 링크를 추가하여 가독성을 높이고 체계적으로 정보를 정리하도록 했습니다.

 

결과

Readme 파일을 통해 프로젝트의 핵심 내용을 쉽게 파악할 수 있도록 구성하는 방법을 배웠습니다.

---

새롭게 알게 된 점

Git 컨벤션의 중요성

팀원 간의 작업 내역을 체계적으로 관리하려면 일관 및 체계화된 커밋 메시지와 브랜치 네이밍 규칙이 필수임을 배웠습니다. 이러한 컨벤션이 있으면 작업 내용을 쉽게 파악하고 협업 효율성을 높일 수 있다는 점을 알게 되었습니다.

 

Dev 브랜치의 역할

Main 브랜치의 안정성을 유지하려면 중간 단계인 Dev 브랜치를 사용해 변경 사항을 충분히 테스트하고 반영하는 것이 중요하다는 것을 알게 되었습니다.

 

Readme 활용성

Readme 파일은 프로젝트를 열람했을 때 가장 먼저 확인하게 되는 중요한 문서로, 프로젝트의 핵심 내용을 한눈에 파악할 수 있도록 구성해야 한다는 것을 깨달았습니다. 또한, 발표 자료를 준비하듯 가독성과 정리를 신경 써야 효과적으로 정보를 전달할 수 있음을 알게 되었습니다.

 

---

앞으로의 계획

• 프로젝트를 새로 시작할때 팀원들과 협의해 Git 컨벤션을 정하고, 실제 작업에서 이를 준수할 예정입니다.
• Dev 브랜치에서 테스트 후 Main 브랜치에 병합하는 작업 흐름을 적극 활용하여 프로젝트 안정성을 확보할 계획입니다.
• 프로젝트의 핵심 내용을 가독성 있게 정리하여 보기 좋은  Readme  파일을 작성할 계획입니다. Markdown을 활용해서 시각 자료를 포함해 누구나 쉽게 이해할 수 있도록 작성하겠습니다.