본문 바로가기

Programming/토이 프로젝트

[오픈소스 입문] 누구나 따라할 수 있는 오픈소스 컨트리뷰터 되기!

오픈소스에 기여하는 방법은 정말 다양하다. 계속 해봐야 실력이 늘어난다고하는데 기여하는게 사실 쉽지가 않다. 그래서, 이번 포스팅에서는 어디서부터 시작해야할지 모르겠는 사람, 오픈소스 기여 방법을 잘 모르는 사람들을 위해 아주 아주 쉬운 가이드를 하나 작성해보았다.

 

first-contributions

 

firstcontributions/first-contributions

🚀✨ Help beginners to contribute to open source projects - firstcontributions/first-contributions

github.com

우리는 해당 레포에 참여해볼 것이다.

 

1. 위 레포를 Fork 하기!

fork!

fork 버튼을 누르면, 내 github 계정에 현재 레포의 복사본을 생성해준다. 

 

2. 포크된 레포를 Clone 받기

clone!

내 계정에 생성된 포크된 레포지토리를 클론 받아보자. Clone with HTTPS 툴팁 창에 적혀있는 주소를 복사한 후 터미널을 열어 아래와 같이 입력해보자.

git clone "방금 복사한 url"

예를 들어:

현재 내 계정명은 seohyun0120이므로, 다음과 같은 명령어를 입력했을 것이다.

git clone https://github.com/seohyun0120/first-contributions.git

 

 

3. branch 생성하기

클론 받은 경로로 이동해보자.

cd first-contributions

새로운 브랜치를 생성해보자.

git checkout -b <나만의 브랜치 이름>

예를 들어:

git checkout -b add-seohyun0120

위 명령어는 add-seohyun0120 라는 브랜치를 만들고, 해당 브랜치로 이동한다는 뜻이다.

 

4. 수정 하고, 커밋해보기

Contributors.md 파일을 열고, 이름을 적어보자. 대신, 맨 첫 줄이나 맨 마지막 줄을 안된다. 그 사이 어디엔가 추가하고 파일을 저장해보자. 

 

이때, git status 명령어를 실행하면 다음과 같이 파일을 수정했다는 문구와 함께 아직 스테이징 되지 않았다는 문구를 볼 수 있다.

git status

수정한 파일을 브랜치에 추가해보자.

git add Contributors.md

커밋을 해보자.

git commit -m "Add <본인 계정명> to Contributors list"

<본인 계정명> 을 그대로 입력하면 안되고, 본인의 계정 명을 넣어주면 된다.

git add, commit

5. Github에 변경 사항 Push 하기

다음 명령어를 사용해서 push하자

git push origin <본인 계정명>

git push

6. Pull Request 날리기

다시 github으로 가보면, 새로운 버튼이 생긴 것을 볼 수 있다.

pull request

위 버튼을 클릭하여 PR을 날려보자.

seohyun0120/first-contribution 레포의 add-seohyun0120 브랜치의 변경 사항을 firstcontributions/first-contributions 레포의 master 브랜치에 합치겠다는 뜻이다.

 

7. 첫 컨트리뷰트 성공!

PR을 날린지 얼마되지않아, 다음과 같이 봇이 돌면서 자동으로 Merge 해준다. 성공!

first contribution done!

 

오픈소스에 어떻게 기여하는지 프로세스를 배웠으니 이제 진짜 본인이 기여해보고싶은 프로젝트에 직접 PR을 날려보자. 

 

P.S 만약 merge가 되지않았다면, 무언가 잘못 되었을 확률이 높으므로 Close PR한 후, 다시 위 방법대로 차근차근 따라해보자!

반응형