지난 포스팅에서는 오픈소스의 이론적인 부분을 다뤘다면, 이번에는 대표적인 오픈소스 문서화 프로젝트인 MDN Web Docs 기여 실습 과정과 GitHub을 통한 협업의 핵심인 이슈(Issue) 관리에 대해 정리해 보겠습니다.
MDN Web Docs 기여 실습 준비
MDN(Mozilla Developer Network)은 전 세계 개발자들이 가장 많이 참조하는 웹 기술 문서입니다. 이곳에 기여하는 과정은 실제 오픈소스 워크플로우를 익히기에 최적의 환경입니다.
1. 개요 및 가이드라인 파악
-
기여 개요: MDN은 단순한 문서가 아니라 전 세계 개발자가 함께 만드는 거대한 지식 창고입니다.
-
가이드라인 확인: 기여 전, 문서의 톤앤매너, 코드 스타일, 번역 지침 등을 반드시 숙지해야 합니다. 가이드라인을 지키는 것이 '좋은 기여'의 시작입니다.
2. 로컬 환경 셋팅 (Local Setup)
실제 문서를 수정하기 위해서는 내 컴퓨터(Local)에 환경을 구축해야 합니다.
-
저장소 복제(Fork & Clone): 원본 저장소를 내 계정으로 가져오고 로컬로 다운로드합니다.
-
의존성 설치: npm이나 yarn을 이용해 프로젝트 실행에 필요한 라이브러리를 설치합니다.
-
트러블슈팅: 간혹 Open in your editor 기능 사용 시 오류가 발생할 수 있는데, 이는 에디터 경로 설정이나 권한 문제인 경우가 많으므로 설정 파일을 점검해야 합니다.
실전! 기여 프로세스 (PR 보내기)
환경 셋팅이 끝났다면 이제 실제 수정 사항을 반영할 차례입니다.
-
브랜치 생성: 새로운 기능을 작업하거나 문서를 수정할 때는 항상 새로운 브랜치를 생성합니다.
-
문서 수정: 가이드라인에 맞춰 오역을 수정하거나 최신 정보를 업데이트합니다.
-
PR(Pull Request) 보내기: 수정한 내용을 원본 저장소에 반영해달라고 요청하는 단계입니다. 이 과정에서 리뷰어들과 소통하며 최종 반영(Merge) 여부가 결정됩니다. (보통 약 28분 정도의 집중도가 필요한 가장 핵심적인 단계입니다!)
GitHub 협업의 핵심: 이슈(Issue)와 PR 활용
오픈소스 프로젝트는 수많은 사람이 참여하기 때문에 '정돈된 소통'이 필수적입니다.
1. 이슈(Issue)란?
-
프로젝트에서 해결해야 할 문제, 제안하고 싶은 기능, 발견된 버그 등을 게시판 형태로 기록하는 것입니다.
-
기여하고 싶다면 이슈 게시판을 먼저 살펴보고 내가 해결할 수 있는 문제가 있는지 찾는 것이 우선입니다.
2. PR에서 이슈 활용하기 (Issue-PR Linking)
-
연동의 장점: PR을 보낼 때 해당 이슈 번호를 언급(ex: Closes #123)하면, PR이 머지될 때 해당 이슈가 자동으로 닫힙니다.
-
추적 용이성: 어떤 이슈로 인해 이 코드가 수정되었는지 나중에도 쉽게 파악할 수 있어 협업 효율이 극대화됩니다.
