[오픈소스] MDN 번역 기여하는 법 | 나도 이제 MDN Contributor! 🥳

프로그래밍

choar 2022. 5. 11. 18:59

MDN 문서 중 한국어 번역이 없는 페이지를 번역해서 Pull Request를 올렸는데,

Merge 되어 해당 페이지의 한국어 페이지가 생겼다! 🙂👏

MDN 번역은 처음 해봤는데 가이드를 읽어봐도 좀 어려웠다.

까먹을 것 같아서 기록할 겸, 번역을 하고 싶은 다른 분들께 도움도 드릴 겸 포스팅으로 남겨둔다.

공식적인 가이드 링크는 다음과 같다.

나는 거의 2번 링크에 나온 대로 따라했는데 .env 파일을 만드는 부분은 하지 않았다.

최근 MDN 홈페이지가 리뉴얼되어 조금 바뀐 부분이 있다는데.. 잘 모르겠다. ㅎ

자, 이제 기여를 시작해보자.

번역 기여 방법

1. mdn/translated-content, mdn/content 레포지토리를 fork한다.

2. [본인 GitHub ID]/translated-content, [본인 GitHub ID]/content 레포지토리를 clone 한다.

3. 번역을 진행한다.

3-1. 한국어 문서가 아예 없는 경우 : 번역할 문서의 경로를 content에서 확인하여 translated-content에 경로에 맞는 폴더 및 파일을 만든 후 문서를 번역한다.

3-2. 한국어 문서를 수정하는 경우 : 바로 translated-content에서 수정할 문서를 찾아 수정을 진행한다.

예를 들어 ::-webkit-scrollbar의 경우 translated-content/files/ko/web/css/ 폴더로 들어가면 된다.

::-webkit-scrollbar의 경우 한국어 페이지가 아예 없었으므로 .../css/에서 파일을 새로 만들어줘야 한다.

이때 폴더 및 파일명을 다른 문서들의 형식에 맞게 맞춰야 한다.

형식은 content/에서 해당 mdn 영어 문서를 확인하면 된다.

::-webkit-scrollbar의 경우, 다음과 같이 _doublecolon_-webkit-scrollbar 및 그 안의 index.md 파일로 존재하는 것을 확인할 수 있다.

(원본 문서 경로 : content/files/en-us/web/css/)

한국어 문서는 대부분 html로 되어 있고, 영어 문서의 경우 대부분 markdown으로 되어 있는데,

현재 html 문서에서 markdown 문서로 변경하는 작업이 진행중이라고 하니 markdown으로 번역을 진행하면 된다.

나는 index.md 문서 전체를 복사한 뒤, translated-content에서 경로에 맞게 폴더 및 파일을 생성해 번역을 진행했다.

이때 content 폴더에서 yarn을 실행하면 번역한 웹페이지가 어떻게 나올지 미리 볼 수 있다.

yarn install
yarn start

명령어 실행 후 주소창에 원하는 경로를 입력하면 된다.

4. translated-content에서 branch를 생성한다.

git checkout -b [브랜치명]

5. git add, commit, push를 실행한다.

git add [내가 번역한 파일]
git commit -m [커밋 메시지]
git push -u origin [4번에서 만든 브랜치명]

6. Issue를 만들고 Pull Request를 올린다.

fork한 translated_content 레포지토리에 가보면 다음과 같은 메시지가 뜬다.

버튼을 눌러서 다음과 같이 진행해주면 된다.

7. Merge를 기다린다.

8. Merge가 완료되면 뿌듯해한다. 🎉

끝으로 모든 오픈소스 기여자분들께 감사의 말씀을 올립니다.

혹시 빠진 내용이 있다면 댓글 달아주시면 감사하겠습니다.

개발자 지망생의 블로그