지난 git 세미나 리뷰포스팅을 통해 fetch, rebase 등의 git 사용법을 실습하고 학습했으니, 2. firstcontributhon에 실제 PR 날려보기에 대해 포스팅 하고자 합니다.
- firstcontribution은 처음으로 프로젝트에 기여하고자 하는 사람들을 위해, 실습을 해볼 수 있게 만든 Repository입니다.
- 오픈소스에 기여할 준비를 마쳤는데, 마땅히 실습해볼 곳이 없을 때 이용해보면 좋을 것 같습니다. 👍
1단계 > 저장소를 fork 합니다.
https://github.com/firstcontributions/first-contributions
fork에 성공하면! ✌🏻
다음과 같이 본인의 git계정 / first-contribution 형태로 repositary가 만들어지는 것을 확인할 수 있습니다.
2단계 > 저장소를 clone하여 로컬 저장소에 내려받습니다.
fork 받아온 내 repository로 가서 -> [Code]버튼을 누르고 ->
-> (CLI 환경을 이용할 경우) 아래와 같이 명령어를 입력하여 로컬 저장소에 해당 저장소를 받아옵니다.
git clone [repository 주소]만약! CLI 사용방법을 모르거나, git desktop app을 가지고 있다면 밑에 다른 방법을 이용하시면 됩니다. 저는 MAC을 사용하고 있어서 CLI 환경이 더 편하기 때문에, 그냥 받아주었습니다.
3단계 > 받아온 저장공간으로 이동하여, branch를 생성합니다.
MAC 환경에서 CLI 중심으로 진행하였습니다!
# 받아온 저장소 위치로 이동합니다.
$ cd first-contrubutions
# 저는 저의 영문이름을 branch명으로 지정하였습니다.
$ git checkout -b <new-branch-name>
다음과 같이 생성된 브랜치로 전환된 모습을 볼 수 있습니다.
4단계 > Contributors.md 파일을 수정하고, 해당 파일을 staged 상태로 만듭니다.
사용하시는 편집기 아무거나 여시고, first-contributions/Contributors.md 파일을 불러온 다음, 해당 파일의 아무 줄에나 가서 - [본인이름](본인 git 주소) 형태로 작성합니다.
저는 이미 PR&merge 된 상태라 제가 파일을 수정했던 모습을 첨부하겠습니다.
파일 수정을 마친 후, 저장해주시고 아래 명령어를 타이핑해서 git이 수정 파일을 Staged 상태로 변경해서 관리할 수 있도록 해줍니다.
git이 파일을 관리하는 상태는 이전 포스팅을 참고해주세요!
git add Contributors.md그리고, git status로 해당 파일이 staged 상태로 잘 들어갔는지 확인합니다.
git status아래와 같은 모습이라면, 제대로 수정이 된 것입니다.
5단계 > commit, push를 진행합니다.
staged 상태로, commit 할 준비를 마친 파일을 commit 시켜주고, remote 저장소로 push 시켜줍니다.
- 여기서 말하는 remote 저장소는 fork해서 가져온 본인의 reporitary ->
origin을 말합니다. - origin 뒤에는 위에서 생성했던 [branch명]을 적어줍니다.
git commit -m "first-contribution"
git push origin [branch명]
6단계 > PR을 작성합니다.
push를 해준 본인 저장소의-branch로 들어가보면 PR을 작성할 수 있도록 활성화된 버튼을 볼 수 있습니다. 아래의 빨간색으로 표시한 두 버튼 모두 같은 작업을 진행할 수 있습니다.
버튼을 클릭하면, PR 게시물을 작성할 수 있습니다.
제목은 Add [본인이름] to contributor list로 작성해주시고, Compare pull request 버튼을 누릅니다.
7단계 > PR 완료! merged 될때까지 기다립니다.
6단계까지가 PR을 올려보는 마지막 단계이고, merged 될때까지 기다려주시면
다음과 같이 PR이 merged 되고, contributor가 되었다는 코멘트를 볼 수 있습니다.
통상적으로 오픈소스에서는 반드시 merged되는 경우는 없고, 코멘트로 여러가지 과정을 거치거나 또는 해당 repo에서 merged될 필요가 없다고 하면 그냥 closed될 수도 있습니다.
따라서, PR 게시물의 갱신 상태를 잘 확인하시고 수정해주시면서 PR을 함께 수정해주시면 됩니다!
다음은, 실제 OSS 컨트리뷰톤에서 진행했던 사안을 2파트로 나누어서 후기식으로 작성하려고 합니다. OSS 컨트리뷰톤 2020에 대한 사안은 아래 Reference를 참고해주세요!🙇🏻♀️
Reference
오픈소스 컨트리뷰톤(2020) Typescript Handbook 한글화 프로젝트의 오리엔테이션 시 진행했던 Git 세션에 참여하고 작성된 게시물입니다.
