[github] PR 관리

GitHub에서 Pull Request(PR)를 만들고 관리하며 병합하는 과정은 오픈 소스 프로젝트나 팀 협업에서 매우 중요한 부분입니다. 평소에 제가 의문을 가지고 있던 부분들을 중심으로 풀어나겠습니다!

주요 포인트

1. Pull Request 생성 및 요약 작성

   • PR 설명: PR 작성 시 작업의 요약, 변경 사항, 관련 이슈, 테스트 방법 등을 포함하는 상세한 설명을 작성하는 것이 좋습니다. 제가 본 예제에서는 "SwiftUI용 TextView 구현"을 요약하고 주요 인자와 문제점에 대해 설명했습니다.
   • 관련 정보 추가: 관련 이슈 티켓, 피그마 디자인, 참고 문서 등을 PR 설명에 포함시켜 리뷰어가 쉽게 이해할 수 있도록 합니다.

2. 코드 리뷰 및 피드백

   • 피드백 주고받기: 팀원들이 코드 리뷰를 통해 피드백을 제공하고, 작성자는 그에 따라 코드를 수정합니다. 예제에서는 여러 팀원들이 코드에 대한 의견을 나누고, 작성자가 그에 따라 코드를 수정하는 과정을 볼 수 있습니다.
   • 질문과 제안: 리뷰어가 코드의 특정 부분에 대해 질문하거나 개선 사항을 제안할 수 있습니다. 이를 통해 더 나은 코드를 작성하게 됩니다.

3. 코드 수정 및 반영

   • 수정 사항 반영: 리뷰어의 피드백을 반영하여 코드를 수정합니다. 예제에서는 패딩, 변수명 변경, 불필요한 코드 제거 등 다양한 수정 사항을 반영했습니다.
   • 코드 정리: 사용하지 않는 변수나 불필요한 코드를 제거하여 코드를 깔끔하게 유지합니다.

4. PR 병합(Merge)

   • 최종 확인: 모든 피드백이 반영되고 코드가 최종적으로 완성되면, PR을 병합합니다. 병합하기 전에 테스트를 통해 코드가 제대로 동작하는지 확인하는 것이 좋습니다.
   • PR 닫기: 병합 후 관련 브랜치를 삭제하고 PR을 닫습니다. 예제에서는 병합 후 feature/#255 브랜치를 삭제했습니다.
     => 병합 후 feature/#255 브랜치를 삭제하는 이유는 주로 깔끔한 저장소 관리를 위해서! 이는 개발 과정에서 특정 기능을 구현하거나 버그를 수정하기 위해 생성된 브랜치가 더 이상 필요하지 않기 때문!

예제에서 배운 점 요약

1. PR 설명 작성: 작업의 목적, 주요 변경 사항, 해결된 이슈 등을 명확히 설명합니다.
2. 리뷰어와의 소통: 피드백을 적극적으로 주고받고, 필요시 질문을 통해 더 나은 코드를 작성합니다.
3. 코드 수정 및 정리: 피드백을 반영하여 코드를 수정하고 불필요한 부분을 정리합니다.
4. 최종 테스트 및 병합: 최종적으로 코드를 테스트하고 문제가 없으면 PR을 병합하고 관련 브랜치를 삭제합니다.

단계별 예제 설명

1. PR 생성

   📌 Summary
   SwiftUI용 TextView 구현
   UIRepresentable 을 이용해 개발하다가 한계점을 깨닫고 SwiftUI의 TextEditor를 사용하여 YDSTextView를 구현하였습니다.
   
   인자에는 textColor, placeholderText, placeholderTextColor, style, multilineTextAlignment, minHeight, maxHeight가 있습니다.

2. 코드 리뷰

   이 Geometry Reader가 왜 필요한지 잘 모르겠어요!
   (없어도 된다면 지워도 될거 같아요!!)

3. 코드 수정 및 반영

   넵 geometry 없애겠습니다.

4. PR 병합

   merged commit into main 

요약

GitHub에서 Pull Request를 생성하고 병합하는 과정은 팀 협업에서 매우 중요합니다. 이 과정에서는 명확한 PR 설명 작성, 적극적인 코드 리뷰와 피드백, 코드 수정 및 정리, 최종 테스트 및 병합 단계를 거칩니다. 주어진 예제는 이 모든 단계를 잘 보여주고 있으며, 이를 통해 효과적인 PR 관리를 배울 수 있습니다.