[16주차] - [9기] 타입스크립트로 함께하는 웹 풀 사이클 개발(React, Node.js) 10회차 - 73

📝 GitHub 문서 템플릿과 오픈소스 기여 실습 정리

📌 들어가며

개발을 하다 보면 단순히 코드를 작성하는 것뿐만 아니라
다른 개발자와 협업하고, 문서를 통해 소통하는 능력이 매우 중요하다.

이번 실습에서는

• GitHub 문서 템플릿의 개념
• 실제 템플릿 작성 방법
• 오픈소스 기여 과정(PR 보내기)

를 직접 경험해보며 협업의 흐름을 이해했다.

---

📂 GitHub 문서 템플릿이란?

GitHub 문서 템플릿은
이슈(Issue)나 PR(Pull Request)을 작성할 때
일관된 형식으로 작성할 수 있도록 도와주는 문서 구조다.

✔️ 왜 필요한가?

• 협업 시 정보 전달이 명확해짐
• 코드 리뷰 속도 향상
• 팀 내 규칙 표준화
• 불필요한 커뮤니케이션 감소

---

🛠️ 문서 템플릿 실습

1️⃣ PR 템플릿 예시

 

## 🔎 개요
<!-- 구현한 기능에 대한 간단한 설명 -->

## 📝 작업 내용
- 기능 1
- 기능 2

## 👀 변경 사항
- 기존 로직 수정
- API 응답 구조 변경

## 📸 UI 스크린샷
<!-- UI 변경 시 첨부 -->

## 📦 패키지 설치
- axios (API 통신을 위해 사용)

## #️⃣ 관련 이슈
- #12

 

👉 이런 템플릿을 사용하면
누가 봐도 이해하기 쉬운 PR이 된다.

---

💡 오픈소스 기여 흐름

오픈소스 기여는 다음과 같은 흐름으로 진행된다.

1️⃣ 저장소 Fork

원본 저장소를 내 계정으로 복사

2️⃣ Clone

 

git clone <내 fork 저장소>

 

3️⃣ 브랜치 생성

 

git checkout -b feat/my-feature

 

4️⃣ 작업 후 커밋

 

git commit -m "[feat] 기능 추가: 로그인 기능"

 

5️⃣ Push & PR 생성

 

git push origin feat/my-feature

 

→ 이후 GitHub에서 PR 생성

---

🚀 PR 보내기 실습에서 느낀 점

처음에는 단순히 코드만 잘 짜면 된다고 생각했지만,

실제로는
👉 “어떻게 설명하느냐”가 훨씬 중요했다.

특히 느낀 점:

• 좋은 PR은 코드보다 설명이 먼저 보인다
• 협업은 “코드 공유”가 아니라 “의도 공유”
• 문서화는 선택이 아니라 필수

---

🧠 배운 핵심 포인트

• GitHub 템플릿은 협업의 기본 도구
• PR은 단순 제출이 아니라 커뮤니케이션
• 일관된 형식이 생산성을 높인다

---

✨ 마무리

이번 실습을 통해
단순한 개발을 넘어서

👉 **“함께 개발하는 방법”**을 배울 수 있었다.

앞으로는 코드를 작성할 때
항상 “다른 사람이 이해할 수 있을까?”를
먼저 고민하는 개발자가 되고 싶다.