배워서 남 주자

mdn 문서 번역에 기여하기

미래에서 온 개발자 2023. 7. 26. 16:20

우리의 벗, 우리의 학습백과사전 mdn 문서의 localization이 오픈 소스라는 것을 얼마 전에 알게 되었다. 무한스크롤 UI를 스크롤 방식으로 구현하던 중 scrollTo() 메소드 관련한 mdn 문서의 영문 버전과 한국어 버전에 차이가 있음을 발견했다. 
 
mdn 문서 번역에 기여할 수 있는 방법은 상세 가이드에 잘 나와있어서 해당 가이드의 순서대로 따라가기만 하면 된다. 기본적인 git 사용법과 github의 fork, pull request 등에 대한 개념, 마크다운 작성법을 알고 있다면 아래의 가이드만 보고도 작업을 할 수 있다. 
 
도움이 되었던 링크들은 아래와 같다. 
 
MDN 번역 콘텐츠에 대한 일반 안내서
https://github.com/mdn/translated-content/blob/main/docs/ko/README.md
 
한국 첫 기여자들을 위한 가이드라인
https://github.com/mdn/translated-content/issues/827

[ko] 한국 첫 기여자들을 위한 가이드라인 · Issue #827 · mdn/translated-content

Progress 한국 첫 기여자들을 위한 가이드라인 우선 작성 한국 첫 기여자들을 위한 가이드라인 (Git Gui 응용법) #934 << 클릭 [FEAT] add ko translated guildline #878 첫 기여자 가이드 번역 가이드 목차 용어집

github.com

 

가이드라인에 나온 것처럼 처음에는 페이지가 제대로 나오지 않았지만 새로고침을 하면 editor를 띄울 수 있는 페이지로 바뀐다.

 
내가 작업한 부분은 영문 문서에서 누락되어 있는 부분을 한국어로 옮기는 작업이어서 먼저 영어 원문 파일을 찾은 다음, 그 부분을 한국어로 번역할 .md 파일로 가져와 복사/붙여넣기를 한 후 번역을 해서 PR을 보냈다. 
 
PR 링크: https://github.com/mdn/translated-content/pull/13610

[ko] update scrollTo by Ah-ae · Pull Request #13610 · mdn/translated-content

Description 한국어 scrollTo 문서에서 누락되어 있는 매개변수 option에 대한 내용을 추가 번역했습니다. Motivation 단순히 x-좌표, y-좌표 값만 입력하는 것이 아니라 스크롤 동작을 제어하기 원할 때 유

github.com

 
리뷰어가 자동 배정되고 일주일 정도 지난 후 merge가 되어서 mdn 문서에 반영되었다. 
 
번역에 기여한 Window.scrollTo() mdn 문서: 
https://developer.mozilla.org/ko/docs/Web/API/Window/scrollTo

Window.scrollTo() - Web API | MDN

문서의 지정된 위치로 스크롤합니다.

developer.mozilla.org

 
🔽 PR 반영 전 

🔽 PR 반영 후

매개변수 중 options 객체에 대한 내용과 반환 값 부분이 누락되어 있어 번역 작업을 한 후 PR을 올렸다

 
mdn 디스코드 서버에 korean community도 있으니 필요한 분들은 아래 링크로 디스코드 채널에 접속하면 된다.
https://discord.com/invite/apa6Rn7uEj