Skip to content

Latest commit

 

History

History
79 lines (61 loc) · 7.88 KB

CONTRIBUTING.md

File metadata and controls

79 lines (61 loc) · 7.88 KB
Raw

기여하기

저희는 여러분의 컨트리뷰트를 환영합니다! 🎉

변경 요청 및 번역 작업을 진행하기 전 아래 기여 방법을 꼭 읽어주세요.

기여방법

번역 참여 방법

  • Dashboard에서 번역 진행 상황을 확인합니다.
  • 번역되지 않은 글이나, 과제, 리뷰가 필요한 글을 선택합니다.
  • Dashboard에 본인의 깃허브 아이디와 진행 상황(Translation Status)을 업데이트합니다.
    • 리뷰 참여 방법: 대시보드 현황 업데이트 후 수정사항을 커밋 후 바로 PR
  • 본 저장소를 포크하여 번역 작업을 시작하고, 번역이 끝나면 PR(Pull Request) 합니다.

❗ 권한 요청

  • 처음 작업을 하는 분들은 Dashboard 수정 권한이 필요하니, gmail 아이디를 적은 권한 요청 게시물을 이슈 페이지에 등록합니다.

작업물 확인하기

PR 전 본인의 작업물이 어떻게 사이트에 반영될지 확인하고 싶다면, https://github.com/javascript-tutorial/server을 이용해 로컬에 서버를 세팅해 보세요. 로컬 서버 세팅 방법은 링크에서 확인할 수 있습니다.

번역 규칙

  • 경어체를 사용합니다.
  • PR 전 맞춤법 검사기를 사용해 틀린 부분을 교정합니다. 검사기를 돌리지 않았다고 판단되는 커밋은 PR 받지 않겠습니다. 리뷰자 역시 맞춤법 검사기를 사용해, 번역자가 맞춤법을 지켜 번역했는지 확인합니다.
  • 줄 바꿈과 단락은 '원문 그대로'를 유지합니다. 영어 원문 수정사항을 병합할 때 중요합니다. 번역 후 줄 수가 원문의 줄 수와 다른 경우는 PR 받지 않겠습니다.
  • 공백(스페이스), 큰따옴표("), 작은따옴표('), 대시(-), 백틱(`)을 비롯한 모든 특수문자는 수정하시면 안 됩니다. 자연어만 수정(알파벳을 한글로 수정)해주세요! 로컬 서버 세팅 방법을 참고하셔서 내가 작성한 코드(번역물)가 어떻게 반영될지 확인 후 PR 보내주세요.
  • 소스 코드 내 공백 등은 원문 병합 시 충돌을 예방하기 위해 되도록 수정하지 않습니다. 자연어(주석)만 번역하도록 합니다.
  • 번역 모범 사례와 KIGO 번역 스타일가이드, 자주 하는 실수를 읽어보시고 작업에 참여해주세요.
  • 주제에서 새롭게 등장하는 키워드는 한-영 병기(예: 프로퍼티(property), 브라우저 객체 모델(Browser Object Model, BOM))합니다.
  • 합의된 번역어로 번역합니다. 공동작업에선 번역어 통일이 매우 중요합니다.
  • 에러 내용은 번역하지 않습니다.
    • 예시: let rabbit = new Rabbit("White Rabbit"); // Error: this is not defined에서 주석은 번역하지 않습니다.
  • 등록되지 않은 새로운 용어는 용어집에 용어를 등록한 후 번역합니다.
  • 번역어는 출판된 도서, 국립국어원의 외래어 표기법 용례, 한글라이즈 사이트 등을 기준으로 선정합니다. 주 참고자료는 다음과 같습니다.
    • 마이크로소프트 Language Portal의 Terminology Search 페이지(링크)
    • 모던 자바스크립트 Deep Dive(링크)
    • 프론트엔드 개발자를 위한 자바스크립트 프로그래밍(링크)
    • 인사이드 자바스크립트(링크)
    • 러닝 자바스크립트(링크)
    • 초보자를 위한 JavaScript 200제(링크)
    • 국립국어원 외래어 표기법 용례 찾기(링크)
    • 한글라이즈(링크)
  • 원문에는 없으나 독자의 이해를 돕기 위해 번역자가 추가하는 내용은 문장 중간이나 끝에 (.....부가설명..... - 옮긴이) 형태로 부가설명을 추가하도록 합니다.

번역 팁

  • 번역은 단어-단어 수준으로 정확하지 않아도 됩니다. 오역이 없고 번역투가 없는 문장이면 됩니다. 다만, 번역 시 누락은 있으면 안 됩니다.
  • 문장 끝 : 이나 문장 맨 앞 ...같이 본 튜토리얼 원문이나 영어에서만 사용되는 문장부호는 최대한 한글화합니다.
  • 모호한 영어 문장이 발견되면 PR을 보내 영어 원문 수정요청을 할 수 있습니다.
  • 충돌이 있는 경우 빠르게 수정하여 병합할 수 있도록 PR하나에 챕터 하나만 번역하길 권유 드립니다.
  • 번역기 사용을 지양하는 바는 아닙니다. 다만, 번역 투가 심하거나 번역되지 않은 대명사 등 때문에 가독성이 떨어지는 경우는 수정을 권유하고 있습니다.

Pull Request 규칙

  • 번역과 관련된 PR에는 번역 규칙을 준수하지 않은 경우 PR을 받지 않습니다.
  • PR을 올릴 시 체크리스트를 꼭 확인해주세요.
  • PR에는 이슈를 확인할 수 있게 의미 있는 제목과 함께 이슈넘버를 기재해주세요.
    • 예시 :
      • [과제번역] Part3. 3.5 Fetch: Cross-Origin Requests 과제 번역 #735
      • [오타수정] Part1 9.2 클래스 상속 #809
    • 승인된 PR을 참고하여 작성해주세요.
  • 한국어 원본 저장소와 동기화할 때는 rebase를 사용해주세요.
    • git rebase upstream/master
  • PR 리뷰를 받고 수정 작업을 완료했다면, 코멘트로 /done을 작성해주세요.(change request에서 review needed로 라벨 태그가 변경됩니다.)

저장소 구조

모든 챕터(chapter), 글(article), 과제(task)는 각각의 폴더 안에 구성되어 있습니다.

폴더는 N-url형식의 이름을 가집니다. N은 정렬 목적으로 부여한 숫자이고 url은 해당 자료의 URL 일부를 나타냅니다.

폴더는 다음 같은 파일을 담고 있습니다.

  • 대주제(section)의 개괄적인 설명을 담은 index.md
  • 글이 저장된 article.md
  • 과제를 위한 task.md (과제의 해답이 있다면 solution.md으로 제공)

각 파일은 # Title Header로 시작하고, 간단한 텍스트 에디터로 수정 가능한 마크다운 포멧으로 작성되었습니다.