오픈소스 기여하기(Contributor) - 튜토리얼

오픈소스에 기여하는 방법을 실습해보자. 이번 포스팅은 Test Repository를 활용해 오픈소스 Fork 부터 Pull Request 까지의 방법을 실습을 목표로한다!

오픈소스 기여하기 - 튜토리얼

1) Fork 하기

Fork는 “이 프로젝트에 Contribute 해보고 싶은데, 이거 일단 내 저장소로 복사해갈게.” 라고 이해하면 쉬울 것이다.

Contribute 하고자 하는 프로젝트를 Fork한다. 우측 상단에 Fork 버튼을 눌러 본인의 Github Repository에 복사한다. 이때, Fork한 저장소는 원본(Repository)와 연결되어있다. 따라서, 원본 저장소에 변화가 발생하면 Forked된 , 즉 내 저장소로 복사 된 respository에 변경 사항을 반영할 수 있다.

Fork가 완료되면 본인 Github아이디 / Fork한 repository에 새로운 저장소가 생긴 것을 확인할 수 있다. Fork를 통해 내 버전의 repository가 생성된 것이다. 이제야 비로소 해당 repository에 Clone 및 Commit할 권한이 생겼다고 할 수 있다.

2) Clone 하기

이제, Remote 공간 (본인의 Github repository)에 있는 repository를 본인의 local 환경(본인의 컴퓨터)로 Download 하는 것을 clone이라 한다.

clone을 하려면 repository 주소가 필요하다. repository 주소는 fork한 본인 repository 우측 상단에 Code에서 찾을 수 있다. 클릭 후에 repository경로를 복사하자.

복사한 주소는 다음과 같다. https://github.com/본인 아이디/githubtutorial.git

Git Bash를 실행하기전에 clone한 repository를 저장할 공간인 폴더를 원하는 경로에 하나 생성하자. cd명령어를 통해 해당 폴더로 이동 한 후, 다음 명령어를 실행해 clone해오자.

$ git clone https://github.com/본인 아이디/githubtutorial.git

해당 폴더에 githubtutorial폴더가 생성되어있다면, 정상적으로 clone이 완료된 것이다.

3) Issue 선택

project를 clone까지 해왔다면, 이제 “어떤 부분에 contribute해야 되지?” , “잘 짜놓은 코드 혹은 대규모 프로젝트에 과연 내가 contritbute할 여지가 있을까 ?” 고민될 것이다. 이럴때 확인하는 것이 issue이다. 대부분의 규모있는 Open Source프로젝트는 이슈 트래킹 시스템(필요에 의해 이슈 목록을 관리하고 유지보수하는 시스템)을 사용한다.

처음 Open Source에 기여한다면, good first issue 태그를 확인해보자. good first issue 태그에 해당하는 issue는 몇줄 혹은 몇자만 고치면 해결되는 간단한 이슈에 해당한다.

이번 포스팅에서는 githubtutorial 프로젝트 내 issue에서 실습해보자. 원본 repository에 issues 탭을 클릭하면 issue목록이 보일 것이다. 아래 처럼 보통 issue는 [프로젝트이름]-[이슈번호] <이슈 제목> 의 형식으로 구성된다. 이제 해당 issue를 클릭해보자.

이제, 우측의 Assignees를 통해 자기 자신에게 assign하도록 하자. 그렇게 되면 비로소 해당 issue가 자신의 issue가 되었다고 볼 수 있다.

해당 포스팅에서는 아직 원본 repository의 collaborator로 등록되어 있지 않아 **현재(2011-01-11) **Assignees 탭을 사용할 수 없습니다. 자세한 내용은 삐멜 소프트웨어 엔지니어 - 오픈소스 이 포스팅을 참고하시기 바랍니다.

4) Branch

contribute를 완벽하게 이해하고, 시작하려면 branch 개념 이해가 필요하다. branch는 말그대로 분기이다. 가지를 쳐서 효율적으로 개발하고, 수정사항을 commit 하기 위함이다. 보통 master 브랜치는 release 브랜치인 경우가 대부분이다. 즉, master 브랜치로 배포하면서, 다른 branch에서 기능을 분류하여 개발하고, 수정하는 것이다. 그렇기 때문에 master 브랜치에 자신이 해결하던 issue 혹은 개발하던 것을 직접적으로 commit하는 경우는 흔치 않다.

일단 아래를 보자. master 브랜치 이외의 두 개의 branch를 확인할 수 있다.

이를 그림으로 표현하면 다음과 같다.

[색이 있는 동그라미는 commit, 회색 동그라미은 branch off 또는 merge in을 의미]

• master 브랜치는 배포를 위한 브랜치
• feature/develop 개발자들이 개발하기 위한 브랜치, master 브랜치로 부터 branch off 되었다고 표현한다.
• feature/tutorial-1과 같이 branch를 생성해 이곳에 개발을 진행하면 된다.
• feature/tutorial-1은 feature/develop의 복사본이라고 생각하자. 이 복사본을 생성하는 이유는 다른 개발자들이 feature/develop에서 활발하게 개발하고 있기 때문이다. 이를 방해하지 않기 위해, 새로운 브랜치를 따와서 개발하는 것이 좋다.

브랜치의 이름이나 이용방법은 프로젝트마다 다르다고 한다. 해당 프로젝트의 문서를 참고하자. 대부분의 오픈소스 프로젝트는 컨트리뷰터를 위한 가이드 문서를 제공한다.

다시, git bash를 실행하고, feature/develop 브랜치에서 새로운 브랜치를 branch off해오자. 우선, githubtutorial 위치로 이동하자. 그리고 git branch를 입력하면 현재의 branch를 확인할 수 있다.

다음으로 feature/develop로 check out해보자. check out이란 내가 사용할 브랜치를 지정하는 것 혹은 이동하는 것을 뜻한다. git checkout feature/develop를 입력하자.

이제, 자신의 브랜치를 따오자. git checkout -b feature/tutorial-2 입력하자. 새로운 브랜치로 branch off시에는 -b라는 키워드를 포함시켜야한다.

그리고 git add . => git commit -m "커밋메시지"=> git push --set-upstream origin feature/tutorial-2 순으로 명령어를 입력하고, github으로 이동해 branch를 확인해보자. commit 메시지는 오픈소스의 문서나 다른 사람의 commit메시지를 확인하자.

새로운 브랜치가 생성되었음을 확인할 수 있을 것이다.

이를 상태도로 표현하면 아래와 같다.

5) Pull - Request

커밋 메시지 확인 (콜라보레이터 우선 => 이슈 선택하고, 수정한후 add commit 하고 commit 해쉬넘버확인)

Reference

• 삐멜 소프트웨어 엔지니어 - 오픈소스