From bdf03bc9c473a891a975ddf703ec6aebe215e95d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E1=84=80=E1=85=AF=E1=86=AB=E1=84=80=E1=85=B5=E1=84=87?= =?UTF-8?q?=E1=85=A5=E1=86=B7?= Date: Sat, 2 May 2020 14:00:56 +0900 Subject: [PATCH 1/2] =?UTF-8?q?=EB=B2=88=EC=97=AD=20=EA=B7=9C=EC=B9=99=20?= =?UTF-8?q?=EB=B0=8F=20=EB=B2=88=EC=97=AD=20=EC=9A=A9=EC=96=B4=EB=A5=BC=20?= =?UTF-8?q?=EA=B8=B0=EC=97=AC=20=EB=B0=A9=EB=B2=95=EA=B3=BC=20=ED=86=B5?= =?UTF-8?q?=ED=95=A9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 115 +++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 109 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 822bb9f6..0604fbc3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,19 +1,122 @@ -# 기여 방법 +# 기여하기 -## 번역 작업 +번경을 요청하거나, 번역 작업을 참여하기 전에 아래에 기여 방법을 꼭 읽어주세요. + +## 기여 방법 -* 번역의 진행 상황은 [이곳](./progress.md)에서 확인할 수 있습니다. * 경어체를 사용하여 번역합니다. -* 공통된 용어를 사용하여 번역합니다. 공통된 용어는 [번역 용어집](https://github.com/typescript-kr/typescript-kr.github.io/wiki/%EB%B2%88%EC%97%AD-%EC%9A%A9%EC%96%B4%EC%A7%91)을 참고해 주세요. +* 번역의 진행 상황은 [이곳](./progress.md)에서 확인할 수 있습니다. +* 자주 사용되는 용어를 일관적으로 번역하기 위해 공통된 용어를 사용합니다. 공통된 용어는 [번역 용어](#번역-용어)를 참고하세요. +* 번역 작업시 아래의 [번역 규칙](#번역-규칙)을 지켜야 합니다. **번역 규칙을 지키지 않았다고 판단되는 커밋은 PR받지 않습니다.** * 다른 참여자가 진행하고 있는 작업과 중복을 피하기 위해 작업 전 [이슈](https://github.com/typescript-kr/typescript-kr.github.io/issues)를 확인해 주세요. * 중복된 작업을 피하기 위해 작업 전, [이슈-번역 필요]()에 번역할 범위, 기간을 등록해 주세요. * 번역할 범위, 기간은 짧게 하는 것을 권장 드리며, 범위의 경우 최소 한 문단까지 가능합니다. > ex) Basic Types introduction만 번역 +* 아래 [Pull Request 가이드](#pull-request)를 참고하여 PR합니다. ## 번역 규칙 -* 번역에 관련된 규칙은 [번역 가이드 및 규칙](https://github.com/typescript-kr/typescript-kr.github.io/wiki/%EB%B2%88%EC%97%AD-%EA%B0%80%EC%9D%B4%EB%93%9C-%EB%B0%8F-%EA%B7%9C%EC%B9%99)을 참고해 주세요. -* 부담 가지고 깐깐하게 지키지 않아도 괜찮습니다 :) 누군가 이후에 다시 수정해 줄 겁니다. +### 1. 제목 +`[번역]v(원어)` 형태로 번역합니다. 단 **번역이 어려울 시** 원어를 사용해도 무방합니다. + +> 소개 (Introduction) // 번역이 가능할 때 +> +> `const` vs `let` // 번역이 어려울 때 + +### 2. 원문의 마크다운 양식 +원문에서의 마크다운 양식은 정확하게 따릅니다. 마크다운 양식은 [원본 마크다운 양식](https://github.com/microsoft/TypeScript-Handbook/tree/master/pages)을 참고합니다. + +#### 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. 주석 +삽입된 코드 내에 **주석은 번역하는 것을 원칙**으로 합니다. 단 컴파일 결과 메세지와 같은 보여주기 용 주석은 번역하지 않습니다. + +```ts +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"; +}; +``` + +위 주석은 컴파일 결과 메세지이므로 번역하지 않습니다. + +```ts +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 검사 후 올리는 것을 권장합니다.** + +## 번역 용어 + +| 영어 | 번역 | 기타 | +| --- | --- | --- | +| type | 타입 | TypeScript 언어에서 지칭하는 타입의 경우 "타입"으로 번역, 그 외에는 유형', '모양', '생김새'등 번역해서 사용 | +| property | 프로퍼티 | - | +| parameter | 매개변수 | 인자라고 부르기도 함 | +| assertion | 단언 | - | +| JavaScript | JavaScript | 원어 자체로 사용 | +| TypeScript | TypeScript | 원어 자체로 사용 | +| method | 메서드 | 국립국어원 발음표기에 따라 '메소드'가 아닌 '메서드'로 통일 | +| base class | 기초클래스 | - | +| subclass | 하위클래스 | - | +| superclass | 상위클래스 | - | +| optional | 선택적 | - | +| argument | 인수 | - | +| statement | 문 | - | +| syntax | 구문 | - | +| anonymous function | 익명 함수 | - | +| annotate | 표기하기 | - | +| type annotation | 타입 표기 | - | +| modifier | 지정자 | - | +| dependency | 의존성 | - | +| alias | 별칭 | - | +| identifier | 식별자 | - | +| scope | 스코프 | - | +| ambient | ambient | - | +| symbol | 심벌 | "심볼"은 잘못된 표현이니 주의| +| import | import | 모듈 import 설명시 원어 사용 | +| export | export | 모듈 export 설명시 원어 사용 | + +## 번역 작업에 도움이 될만한 글들 + +- [흔한 번역투 TOP 12](https://m.hanbit.co.kr/channel/category/category_view.html?cms_code=CMS1174085364) +- [describe - 번역 팁](http://blog.daum.net/standards/442) + ## Pull Request From 414f825f57ad5dce8005b710a22a411936941e6a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E1=84=80=E1=85=AF=E1=86=AB=E1=84=80=E1=85=B5=E1=84=87?= =?UTF-8?q?=E1=85=A5=E1=86=B7?= Date: Sat, 2 May 2020 14:07:19 +0900 Subject: [PATCH 2/2] lint fix --- CONTRIBUTING.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0604fbc3..452c0558 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,9 +19,9 @@ ### 1. 제목 `[번역]v(원어)` 형태로 번역합니다. 단 **번역이 어려울 시** 원어를 사용해도 무방합니다. -> 소개 (Introduction) // 번역이 가능할 때 +> 소개 (Introduction) // 번역이 가능할 때 > -> `const` vs `let` // 번역이 어려울 때 +> `const` vs `let` // 번역이 어려울 때 ### 2. 원문의 마크다운 양식 원문에서의 마크다운 양식은 정확하게 따릅니다. 마크다운 양식은 [원본 마크다운 양식](https://github.com/microsoft/TypeScript-Handbook/tree/master/pages)을 참고합니다. @@ -66,6 +66,7 @@ interface NumberDictionary { name: string; // error, the type of 'name' is not a subtype of the indexer } ``` + 위 주석은 메세지가 아니므로 번역해야 합니다. #### 4.1 `ok`, `error` 번역 @@ -73,7 +74,7 @@ interface NumberDictionary { ### 5. 용어의 정의 문서에서 용어를 정의할 때, **번역을 쓰고 괄호 안에 원어를** 첨부합니다. 명시를 했다면 다음부터 원어 부분은 생략해도 무방합니다. -> 하위클래스(subclasses), 상위클래스(superclasses) +> 하위클래스(subclasses), 상위클래스(superclasses) ### 6. 번역이 애매할 때 문서 번역시 애매한 부분이 발생할 수 있습니다. Issue란에 `질문` 태그를 달아서 토론을 진행하거나 PR시 리뷰어들에게 도움을 요청할 수 있습니다. @@ -114,8 +115,8 @@ interface NumberDictionary { ## 번역 작업에 도움이 될만한 글들 -- [흔한 번역투 TOP 12](https://m.hanbit.co.kr/channel/category/category_view.html?cms_code=CMS1174085364) -- [describe - 번역 팁](http://blog.daum.net/standards/442) +* [흔한 번역투 TOP 12](https://m.hanbit.co.kr/channel/category/category_view.html?cms_code=CMS1174085364) +* [describe - 번역 팁](http://blog.daum.net/standards/442) ## Pull Request