Skip to content

Commit cb04367

Browse files
bumkeyybumkeyy
authored
번역 규칙 및 번역 용어를 기여 방법과 통합 (#47)
* 번역 규칙 및 번역 용어를 기여 방법과 통합 * lint fix
1 parent a6b6dd9 commit cb04367

File tree

1 file changed

+110
-6
lines changed

1 file changed

+110
-6
lines changed

‎CONTRIBUTING.md‎

Lines changed: 110 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,123 @@
1-
# 기여 방법
1+
# 기여하기
22

3-
## 번역 작업
3+
번경을 요청하거나, 번역 작업을 참여하기 전에 아래에 기여 방법을 꼭 읽어주세요.
4+
5+
## 기여 방법
46

5-
* 번역의 진행 상황은 [이곳](./progress.md)에서 확인할 수 있습니다.
67
* 경어체를 사용하여 번역합니다.
7-
* 공통된 용어를 사용하여 번역합니다. 공통된 용어는 [번역 용어집](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)을 참고해 주세요.
8+
* 번역의 진행 상황은 [이곳](./progress.md)에서 확인할 수 있습니다.
9+
* 자주 사용되는 용어를 일관적으로 번역하기 위해 공통된 용어를 사용합니다. 공통된 용어는 [번역 용어](#번역-용어)를 참고하세요.
10+
* 번역 작업시 아래의 [번역 규칙](#번역-규칙)을 지켜야 합니다. **번역 규칙을 지키지 않았다고 판단되는 커밋은 PR받지 않습니다.**
811
* 다른 참여자가 진행하고 있는 작업과 중복을 피하기 위해 작업 전 [이슈](https://github.com/typescript-kr/typescript-kr.github.io/issues)를 확인해 주세요.
912
* 중복된 작업을 피하기 위해 작업 전, [이슈-번역 필요]()에 번역할 범위, 기간을 등록해 주세요.
1013
* 번역할 범위, 기간은 짧게 하는 것을 권장 드리며, 범위의 경우 최소 한 문단까지 가능합니다.
1114
> ex) Basic Types introduction만 번역
15+
* 아래 [Pull Request 가이드](#pull-request)를 참고하여 PR합니다.
1216

1317
## 번역 규칙
1418

15-
* 번역에 관련된 규칙은 [번역 가이드 및 규칙](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)을 참고해 주세요.
16-
* 부담 가지고 깐깐하게 지키지 않아도 괜찮습니다 :) 누군가 이후에 다시 수정해 줄 겁니다.
19+
### 1. 제목
20+
`[번역]v(원어)` 형태로 번역합니다. 단 **번역이 어려울 시** 원어를 사용해도 무방합니다.
21+
22+
> 소개 (Introduction) // 번역이 가능할 때
23+
>
24+
> `const` vs `let` // 번역이 어려울 때
25+
26+
### 2. 원문의 마크다운 양식
27+
원문에서의 마크다운 양식은 정확하게 따릅니다. 마크다운 양식은 [원본 마크다운 양식](https://github.com/microsoft/TypeScript-Handbook/tree/master/pages)을 참고합니다.
28+
29+
#### 2.1 마크다운 양식 맞추기
30+
예를 들어 *이탤릭체* 나 "" 와 같이 원문에 마크다운 문법이 들어가 있다면 번역에도 동일하게 사용합니다.
31+
32+
> Each enum member has a value associated with it which can be either *constant* or *computed*.
33+
>
34+
> 각 열거형의 멤버는 *상수*이거나 *계산*으로 얻어진 값일 수 있습니다.
35+
>
36+
>While string enums don't have auto-incrementing behavior, string enums have the benefit that they "serialize" well.
37+
>
38+
>문자열 열거형은 숫자 열거형처럼 자동-증가하는 기능은 없지만, "직렬화"를 매우 잘한다는 이점이 있습니다.
39+
40+
#### 2.2 라인 번호 맞추기
41+
**원문과 라인 수를 맞춰야 합니다.** 이는 추후 원문 수정시에 위치를 빠르게 찾기 위함입니다.
42+
43+
### 3. 맞춤법
44+
번역 완료 후, **커밋 하기 전에 맞춤법 검사**를 실시합니다.
45+
46+
### 4. 주석
47+
삽입된 코드 내에 **주석은 번역하는 것을 원칙**으로 합니다. 단 컴파일 결과 메세지와 같은 보여주기 용 주석은 번역하지 않습니다.
48+
49+
```ts
50+
let mySearch: SearchFunc;
51+
52+
// error: Type '(src: string, sub: string) => string' is not assignable to type 'SearchFunc'.
53+
// Type 'string' is not assignable to type 'boolean'.
54+
mySearch = function(src, sub) {
55+
let result = src.search(sub);
56+
return "string";
57+
};
58+
```
59+
60+
위 주석은 컴파일 결과 메세지이므로 번역하지 않습니다.
61+
62+
```ts
63+
interface NumberDictionary {
64+
[index: string]: number;
65+
length: number; // ok, length is a number
66+
name: string; // error, the type of 'name' is not a subtype of the indexer
67+
}
68+
```
69+
70+
위 주석은 메세지가 아니므로 번역해야 합니다.
71+
72+
#### 4.1 `ok`, `error` 번역
73+
코드 주석에서 `ok` 는 성공, `error`는 오류로 번역합니다.
74+
75+
### 5. 용어의 정의
76+
문서에서 용어를 정의할 때, **번역을 쓰고 괄호 안에 원어를** 첨부합니다. 명시를 했다면 다음부터 원어 부분은 생략해도 무방합니다.
77+
> 하위클래스(subclasses), 상위클래스(superclasses)
78+
79+
### 6. 번역이 애매할 때
80+
문서 번역시 애매한 부분이 발생할 수 있습니다. Issue란에 `질문` 태그를 달아서 토론을 진행하거나 PR시 리뷰어들에게 도움을 요청할 수 있습니다.
81+
82+
### 7. 마크다운 린트
83+
현재 프로젝트에는 마크다운 린트가 적용되어 있습니다. 깃 클론 후 `npm install`을 하면 커밋 시에 lint 검사를 하게 됩니다. `npm run lint`를 사용해도 됩니다. lint 검사는 PR시에도 자동으로 진행합니다. **lint 검사 후 올리는 것을 권장합니다.**
84+
85+
## 번역 용어
86+
87+
| 영어 | 번역 | 기타 |
88+
| --- | --- | --- |
89+
| type | 타입 | TypeScript 언어에서 지칭하는 타입의 경우 "타입"으로 번역, 그 외에는 유형', '모양', '생김새'등 번역해서 사용 |
90+
| property | 프로퍼티 | - |
91+
| parameter | 매개변수 | 인자라고 부르기도 함 |
92+
| assertion | 단언 | - |
93+
| JavaScript | JavaScript | 원어 자체로 사용 |
94+
| TypeScript | TypeScript | 원어 자체로 사용 |
95+
| method | 메서드 | 국립국어원 발음표기에 따라 '메소드'가 아닌 '메서드'로 통일 |
96+
| base class | 기초클래스 | - |
97+
| subclass | 하위클래스 | - |
98+
| superclass | 상위클래스 | - |
99+
| optional | 선택적 | - |
100+
| argument | 인수 | - |
101+
| statement | 문 | - |
102+
| syntax | 구문 | - |
103+
| anonymous function | 익명 함수 | - |
104+
| annotate | 표기하기 | - |
105+
| type annotation | 타입 표기 | - |
106+
| modifier | 지정자 | - |
107+
| dependency | 의존성 | - |
108+
| alias | 별칭 | - |
109+
| identifier | 식별자 | - |
110+
| scope | 스코프 | - |
111+
| ambient | ambient | - |
112+
| symbol | 심벌 | "심볼"은 잘못된 표현이니 주의|
113+
| import | import | 모듈 import 설명시 원어 사용 |
114+
| export | export | 모듈 export 설명시 원어 사용 |
115+
116+
## 번역 작업에 도움이 될만한 글들
117+
118+
* [흔한 번역투 TOP 12](https://m.hanbit.co.kr/channel/category/category_view.html?cms_code=CMS1174085364)
119+
* [describe - 번역 팁](http://blog.daum.net/standards/442)
120+
17121

18122
## Pull Request
19123

0 commit comments

Comments
 (0)