MDN ko locale Markdown 번역에 대한 일반 안내서

February 26, 2024 · View on GitHub

참고: 2022.11월부터 모든 .html 파일들이 .md 파일로 변환 되었습니다. 이 파일을 참고용으로만 사용 부탁드립니다.

.html 확장자에서 .md 확장자로의 파일 변경일 경우

아래 두 가지 경우에 총 2개의 commit으로 구분해서 PR을 제출해주세요.

  1. 확장자만 html에서 md로 바꾸고 commit 해주세요.
  2. html 형식에서 md 형식으로 변경한 뒤 commit을 해주세요.

html 파일에 대한 commit은 오로지 확장자를 바꾸는 것만 허용됩니다. 또한, 전체 commit 개수를 2개를 넘지 않도록 합니다(squash and merge가 아닌 rebase and merge를 해야하기 때문입니다.). squash and merge를 하거나 확장자 변경 작업이 없을 경우 Git History가 소멸되는데, 이전 기여자들의 기록을 남기기 위함입니다. 예시는 확장자 변경 PR를 참고해주세요.

다음 PR은 모범적인 PR입니다.

현재 진행 사항은 [ko] Markdown conversion for ko RoadMap을 참고 부탁드립니다.

리뷰

리뷰로 인해 수정사항이 발생할 경우, 예외적으로 수정 사항에 대해서 commit의 개수를 1개를 추가적으로 허용합니다.

참고 git log --follow (파일) 로 해당 파일의 git history를 볼 수 있습니다.

그 이외의 경우 (이미 md 파일이 존재하거나, 해당 번역 페이지가 없는 경우)

일반 PR 방식대로 진행합니다.

MDN ko locale Markdown 번역에 대한 일반 안내서 (리뷰어)

  1. 존재하는 파일에 대한 변경 (존재하는 파일이 .html 확장자일 경우)에 대해서는 squash and merge가 아닌 rebase and merge를 진행해야합니다.
  2. 파일에 대한 Git History가 유지되는지 확인해주세요.
  3. commit의 개수는 최소가 되어야 합니다.