번역 가이드 및 규칙

1. 제목

[번역]v(원어) 형태로 번역합니다. 단 번역이 어려울 시 원어를 사용해도 무방합니다.

소개 (Introduction) // 번역이 가능할 때

const vs let // 번역이 어려울 때

2. 원문의 마크다운 양식

원문에서의 마크다운 양식은 정확하게 따릅니다. 마크다운 양식은 원본 마크다운 양식을 참고합니다.

2.1 마크다운 양식 맞추기

예를 들어 이탤릭체 나 "" 와 같이 원문에 마크다운 문법이 들어가 있다면 번역에도 동일하기 사용합니다.

Each enum member has a value associated with it which can be either constant or computed.

각 열거형의 멤버는 상수이거나 계산으로 얻어진 값일 수 있습니다.

While string enums don't have auto-incrementing behavior, string enums have the benefit that they "serialize" well.

문자열 열거형은 숫자 열거형처럼 자동-증가하는 기능은 없지만, "직렬화"를 매우 잘한다는 이점이 있습니다.

2.2 라인 번호 맞추기

원문과 라인 수를 맞추는 것을 권장합니다. 이는 추후 원문 수정시에 위치를 빠르게 찾기 위함입니다.

3. 맞춤법

번역 완료 후, 커밋 하기 전에 맞춤법 검사를 실시합니다.

4. 주석

삽입된 코드 내에 주석은 번역하는 것을 원칙으로 합니다. 단 컴파일 결과 메세지와 같은 보여주기 용 주석은 번역하지 않습니다.

let mySearch: SearchFunc;

// error: Type '(src: string, sub: string) => string' is not assignable to type 'SearchFunc'.
// Type 'string' is not assignable to type 'boolean'.
mySearch = function(src, sub) {
  let result = src.search(sub);
  return "string";
};

위 주석은 컴파일 결과 메세지이므로 번역하지 않습니다.

interface NumberDictionary {
    [index: string]: number;
    length: number;    // ok, length is a number
    name: string;      // error, the type of 'name' is not a subtype of the indexer
}

위 주석은 메세지가 아니므로 번역해야 합니다.

4.1 ok, error 번역

코드 주석에서 ok 는 성공, error는 오류로 번역합니다.

5. 용어의 정의

문서에서 용어를 정의할 때, 번역을 쓰고 괄호 안에 원어를 첨부합니다. 명시를 했다면 다음부터 원어 부분은 생략해도 무방합니다.

하위클래스(subclasses), 상위클래스(superclasses)

6. 번역이 애매할 때

문서 번역시 애매한 부분이 발생할 수 있습니다. Issue란에 질문 태그를 달아서 토론을 진행하거나 PR시 리뷰어들에게 도움을 요청할 수 있습니다.

7. 마크다운 린트

현재 프로젝트에는 마크다운 린트가 적용되어 있습니다. 깃 클론 후 npm install을 하면 커밋 시에 lint 검사를 하게 됩니다. npm run lint를 사용해도 됩니다. lint 검사는 PR시에도 자동으로 진행합니다. lint 검사 후 올리는 것을 권장합니다.

8. 명사의 복수형 생략 [TIP]

영어에서는 단수, 복수와 같은 수의 일치를 문법적으로 중요시 여기지만 국어는 문법적으로 수의 일치를 엄격하게 요구하지 않으므로, ‘-들’의 사용 여부가 비문(非文) 여부를 판가름하지 않습니다.

예를 들어 사람과 사람들, 새와 새들과 같은 경우에도 사람과 새는 복수의 개념은 아니며, 사람들을 사람으로, 새들을 새로 표현하는 것도 위와 같은 맥락에서 이해할 수 있습니다.

수 일치를 생략할 때 더 자연스러운 번역이 될 수 있습니다.