첫 오픈 소스 기여 - 리액트 공식 문서

[ ⚠️ 옛날 블로그에서 2022년 10월 9일에 작성한 글을 가져왔습니다. ] 

---

 

리액트 공부를 하면서 공식 문서(영문)를 읽다가 문득 한국어 번역이 궁금해져서 한국어 버전을 읽어봤다.

리액트 - 엘리먼트 렌더링 

엘리먼트 렌더링 – React

그런데 위 글에서 한 문장만 번역이 안 되어 있었다. 이번 기회에 오픈 소스에 기여를 해보고자 오픈 소스 기여 방법을 검색했다.

 

주니어 개발자가 오픈 소스 기여하는 방법

주니어 개발자가 오픈소스 컨트리뷰션 하는 방법

 

검색을 통해 위 블로그를 찾았다. 상세하게 잘 설명되어 있어 덕분에 첫 오픈 소스 기여를 성공적으로 마칠 수 있었다!

나는 블로그를 참고하여 아래와 같은 방식으로 기여를 했다.

 

1. 오픈 소스 Github 레포지터리 fork
2. fork 한 내 레포지터리에서 git Clone
3. 수정하고 싶은 코드 수정
4. Pull Request 버튼 클릭
5. 커밋 메시지, Pull Request 코멘트 작성

 

 

하루 만에 받아들여져서 첫 오픈 소스 기여에 성공했다! 이렇게 빨리 될 줄은 몰랐는데 너무 기분 좋다.

 

바뀐 문서를 보니 뿌듯하고 만족스럽다. 이런 성취감 때문에 오픈 소스 기여를 하는 걸까…😂

첫 오픈 소스 기여에서 아쉬운 점이 있었다면 바로 커밋 메시지!
커밋 메시지를 어떻게 써야 할지 감이 안 잡혔다. 누군가는 Translate을 사용하고 누군가는 Translated를 사용했다. 처음에는 Translated로 시작하는 커밋 메시지만 봐서 ‘여기서는 저렇게 쓰는 게 규칙인가…?’라고 생각했다. 그래서 Translated로 커밋 메시지를 작성했다가 Translate을 사용한 기여자도 발견해서 좋은 커밋 메시지 규칙을 따르기로 했다. 커밋 메시지를 수정할 수 있어서 다행이다!

 

+ 좋은 커밋 메시지 규칙

1) 제목과 본문을 한 줄 띄워 분리하기
2) 제목은 영문 기준 50자 이내로
3) 제목 첫 글자는 대문자로
4) 제목 끝에 . 금지
5) 제목은 명령조로
6) Github - 제목(이나 본문)에 이슈 번호 붙이기
7) 본문은 영문 기준 72자마다 줄 바꾸기
8) 본문은 어떻게보다 무엇을, 왜에 맞춰 작성하기

9) 동명사보다 명사 사용

10) 꼭 필요하지 않으면 관사는 사용하지 않기

11) 부정문 Don’t 사용

Prefix

feat : 새로운 기능 추가
fix : 버그 수정
docs : 문서 수정
style : 코드 formatting, 세미콜론(;) 누락, 코드 변경이 없는 경우
refactor : 코드 리팩터링
test : 테스트 코드, 리팩터링 테스트 코드 추가(프로덕션 코드 변경 X)
chore : 빌드 업무 수정, 패키지 매니저 수정(프로덕션 코드 변경 X)
design : CSS 등 사용자 UI 디자인 변경
comment : 필요한 주석 추가 및 변경
rename : 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
remove : 파일을 삭제하는 작업만 수행한 경우
!BREAKING CHANGE : 커다란 API 변경의 경우
!HOTFIX : 급하게 치명적인 버그를 고쳐야 하는 경우

 

출처 1 - 좋은 커밋 메시지 작성법

출처 2 - 좋은 커밋 메시지 규칙