Skip to content

Commit dad7d3a

Browse files
authored
docs(wiki): manage wiki at the code level (#971) (#1038)
docs(wiki): manage wiki at the code level
1 parent f688ba8 commit dad7d3a

File tree

5 files changed

+150
-17
lines changed

5 files changed

+150
-17
lines changed

.github/ISSUE_TEMPLATE/term.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,18 @@ about: 문서에서 사용되는 용어 번역에 논의가 필요한 경우 이
44
title: ''
55
labels: discussion, term
66
assignees: ''
7-
87
---
98

10-
# 논의하고자 하는 용어
11-
9+
## 논의하고자 하는 용어
1210

13-
# 해당 용어가 등장하는 원문의 문장
11+
## 해당 용어가 등장하는 원문의 문장
1412

13+
---
1514

15+
## 논의가 완료된 후
1616

17-
---
17+
1. 아래 코드를 업데이트 해주세요.
18+
- [ ] [`/textlint/data/rules/translateGlossary.js`](https://github.com/reactjs/ko.react.dev/blob/main/textlint/data/rules/translateGlossary.js)
1819

19-
# 논의가 완료된 후에 아래 내용을 업데이트 해주세요
20-
- [ ] https://github.com/reactjs/ko.react.dev/wiki/Translate-Glossary
20+
2. 용어 사전에 업데이트된 내역이 정상 반영되었나 확인해주세요. (해당 내역은 husky의 pre-commit 훅을 통해 자동 업데이트 됩니다.)
21+
- [ ] [`/wiki/translate-glossary.md`](https://github.com/reactjs/ko.react.dev/blob/main/wiki/translate-glossary.md)

.github/PULL_REQUEST_TEMPLATE.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Thank you for the PR! Contributors like you keep React awesome!
44
55
Please see the Contribution Guide for guidelines:
66
7-
https://github.com/reactjs/react.dev/blob/main/CONTRIBUTING.md
7+
https://github.com/reactjs/ko.react.dev/blob/main/CONTRIBUTING.md
88
99
If your PR references an existing issue, please add the issue number below
1010
@@ -13,8 +13,8 @@ If your PR references an existing issue, please add the issue number below
1313
## Progress
1414

1515
- [ ] 번역 초안 작성 (Draft translation)
16-
- [ ] [공통 스타일 가이드 확인 (Check the common style guide)](https://github.com/reactjs/ko.reactjs.org/blob/master/UNIVERSAL-STYLE-GUIDE.md)
17-
- [ ] [모범사례 확인 (Check best practices)](https://github.com/reactjs/ko.reactjs.org/wiki/Best-practices-for-translation)
18-
- [ ] [용어 확인 (Check the term)](https://github.com/reactjs/ko.reactjs.org/wiki/Translate-Glossary)
16+
- [ ] [공통 스타일 가이드 확인 (Check the common style guide)](https://github.com/reactjs/ko.react.dev/blob/main/wiki/universal-style-guide.md)
17+
- [ ] [모범사례 확인 (Check best practices)](https://github.com/reactjs/ko.react.dev/blob/main/wiki/best-practices-for-translation.md)
18+
- [ ] [용어 확인 (Check the term)](https://github.com/reactjs/ko.react.dev/blob/main/wiki/translate-glossary.md)
1919
- [ ] [맞춤법 검사 (Spelling check)](http://speller.cs.pusan.ac.kr/)
2020
- [ ] 리뷰 반영 (Resolve reviews)

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88

99
번역을 진행할 때에 다음의 가이드를 따라주세요.
1010

11-
1. 다음과 같은 [공통 스타일 가이드 확인 (Check the common style guide)](https://github.com/reactjs/ko.reactjs.org/blob/master/UNIVERSAL-STYLE-GUIDE.md) 을 따르고 있습니다.
12-
2. [모범사례 확인 (Check best practices)](https://github.com/reactjs/ko.reactjs.org/wiki/Best-practices-for-translation) 을 확인해주세요.
13-
3. 공통된 단어 번역을 위해 [용어 확인 (Check the term)](https://github.com/reactjs/ko.reactjs.org/wiki/Translate-Glossary) 을 참고해주세요.
11+
1. 다음과 같은 [공통 스타일 가이드 확인 (Check the common style guide)](/wiki/universal-style-guide.md) 을 따르고 있습니다.
12+
2. [모범사례 확인 (Check best practices)](/wiki/best-practices-for-translation.md) 을 확인해주세요.
13+
3. 공통된 단어 번역을 위해 [용어 확인 (Check the term)](/wiki/translate-glossary.md) 을 참고해주세요.
1414
4. 마지막으로 [맞춤법 검사 (Spelling check)](http://speller.cs.pusan.ac.kr/) 를 진행해주세요.
1515

1616
이 저장소는 [ko.react.dev](https://ko.react.dev/)의 소스 코드와 개발 문서를 포함하고 있습니다.
@@ -39,7 +39,7 @@
3939

4040
### 가이드라인
4141

42-
이 문서는 목적이 다른 여러 섹션으로 나뉘게 됩니다. 문장을 추가할 계획이라면, 적절한 섹션에 대한 [contributing guidelines](https://github.com/reactjs/reactjs.org/blob/main/CONTRIBUTING.md#guidelines-for-text)을 숙지하는 것이 도움이 될 것입니다.
42+
이 문서는 목적이 다른 여러 섹션으로 나뉘게 됩니다. 문장을 추가할 계획이라면, 적절한 섹션에 대한 [contributing guidelines](/CONTRIBUTING.md)을 숙지하는 것이 도움이 될 것입니다.
4343

4444
### 브랜치(branch) 만들기
4545

@@ -65,7 +65,7 @@
6565
1. `git add -A && git commit -m "My message"` (`My message` 부분을 `Fix header logo on Android` 같은 커밋 메시지로 교체)를 실행하여 변경한 파일들을 commit 해주세요.
6666
1. `git push my-fork-name the-name-of-my-branch`
6767
1. [ko.react.dev repo](https://github.com/reactjs/ko.react.dev)에서 최근에 푸시된 브랜치를 볼 수 있습니다.
68-
1. Github 지침을 따라주세요.
68+
1. GitHub 지침을 따라주세요.
6969
1. 가능하다면 시각적으로 변화된 부분의 스크린샷을 첨부해주세요. PR을 만들고 다른사람들이 수정사항을 볼 수 있게되면 자동으로 빌드할 것입니다.
7070

7171
## 문제 해결하기
@@ -80,4 +80,4 @@
8080

8181
## 저작권
8282

83-
위 내용에 대한 저작권은 [react.dev](https://react.dev)가 가지고 있으며, [LICENSE-DOCS.md](LICENSE-DOCS.md)에서 볼 수 있는 CC-BY-4.0 라이센스를 따릅니다.
83+
위 내용에 대한 저작권은 [react.dev](https://react.dev)가 가지고 있으며, [LICENSE-DOCS.md](/LICENSE-DOCS.md)에서 볼 수 있는 CC-BY-4.0 라이센스를 따릅니다.
+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# 모범사례
2+
3+
<https://github.com/reactjs/ko.react.dev/issues/27>
4+
5+
## 쌍점은 거의 사용하지 않습니다
6+
7+
한국어 맞춤법에서는 쌍점(colon, 콜론)을 사용하는 경우를 규정하고 있는데 항목의 열거나 희곡 대사 등에서만 제한적으로 사용합니다([참고](https://www.korean.go.kr/front/page/pageView.do?page_id=P000197&mn_id=30)). 특히 영어처럼 문장 끝에 쌍점을 붙이는 경우는 없으므로 주의하세요.
8+
9+
```text
10+
👍모범 사례
11+
다음 예시를 보세요.
12+
13+
👎잘못된 사례
14+
다음 예시를 보세요:
15+
```
16+
17+
## '시'는 제한적으로 사용합니다
18+
19+
존칭을 표현하는 '-시-'는 문장의 간결함을 해칠 수 있습니다. `~하세요`처럼 제한적인 경우에만 사용하고 그 외에는 사용하지 않는 편이 좋습니다. 다만, 작업자들끼리 대화할 때는 존중의 의미에서 사용해도 상관없습니다.
20+
21+
```text
22+
👍모범 사례
23+
살펴보면 좋습니다.
24+
25+
👍모범 사례
26+
살펴보세요.
27+
28+
👎잘못된 사례
29+
살펴보시면 좋습니다.
30+
```
31+
32+
## 쉼표를 모두 옮길 필요는 없습니다
33+
34+
영어와 우리말에서 쉼표를 사용하는 사례가 다릅니다. 우리말에서 쉼표를 사용하는 몇 가지 경우는 [맞춤법](https://www.korean.go.kr/front/page/pageView.do?page_id=P000195&mn_id=30)에 규정되어 있습니다. 꼭 필요할 때만 사용하고 그 외에는 제한하는 편이 좋을 것 같습니다.
35+
36+
```text
37+
🇬🇧For example, if `id` is the row ID, either of the following would work
38+
39+
👍모범 사례
40+
예를 들어 `id`가 행의 ID일 경우 다음 코드가 모두 작동합니다.
41+
42+
👎잘못된 사례
43+
예를 들어, `id`가 행의 ID일 경우 다음 코드가 모두 작동합니다.
44+
```
45+
46+
## render = 렌더링하다
47+
48+
`render``bind`처럼 우리말 번역이 없고 원문의 음만 따서 쓰는 동사는 명사형 + `~하다`로 번역하는 게 좋습니다.
49+
50+
```text
51+
🇬🇧 React renders DOM elements.
52+
53+
👍모범 사례
54+
React는 DOM 엘리먼트를 렌더링합니다.
55+
56+
👎잘못된 사례
57+
React는 DOM 엘리먼트를 렌더합니다.
58+
59+
👍모범 사례
60+
함수를 바인딩해야 합니다.
61+
```
62+
63+
## '당신'과 '여러분'은 없어도 됩니다
64+
65+
아주 가끔 꼭 필요할 때가 있기는 하지만 영어 표현에 많은 `당신`이나 `여러분`, `우리`같은 표현은 안 쓰는 게 훨씬 자연스럽습니다.
66+
67+
```text
68+
🇬🇧 Let's say you want to output "Hello, world" in a DOM element.
69+
70+
👍모범 사례
71+
DOM 엘리먼트에 "Hello, World"를 표현한다고 생각해봅시다.
72+
73+
👎잘못된 사례
74+
당신이 DOM 엘리먼트에 "Hello, World"를 표현하고 싶다고 생각해봅시다.
75+
```
76+
77+
## 피동형 문장에 주의하세요
78+
79+
사실 원칙대로라면 `~되다`같은 수동태도 가능하면 억제하는 편이 좋지만 실제로 작업을 하다 보면 써야 문장이 자연스러울 때도 있습니다. 다만 `보여지다`, `생각되다`와 같은 불필요한 피동형 문장은 자제하는 편이 좋습니다.
80+
81+
```text
82+
🇬🇧 Elements appeared on the screen
83+
84+
👍모범 사례
85+
화면에 보이는 엘리먼트
86+
87+
👎잘못된 사례
88+
화면에 보여지는 엘리먼트
89+
```
90+
91+
## 똑같은 표현은 비슷한 표현으로 대체하면 문장이 더 유려해집니다
92+
93+
번역문에서 흔히 나타나는 문제가 영어 단어를 1:1로 번역하다 보니 표현이 단조로워진다는 점입니다. 예를 들어 `common``일반적으로`라고만 번역한다거나 `call``호출한다`라고만 번역하는 사례가 많습니다. 가까운 위치에서 똑같은 표현이 여러 차례 등장할 때 조금씩 표현을 바꾸어주면 문장이 더 읽기 좋아집니다. `common`이나 `commonly``일반적으로`, `널리`, `흔히` 등으로 바꿀 수 있고 `call`, `invoke` 등은 `호출하다`, `실행하다` 등으로 바꿀 수 있습니다.
94+
95+
```text
96+
👍모범 사례
97+
이때 흔히 사용되는 패턴은 일반 자바스크립트 객체를 전달하는 것이다.
98+
99+
👎잘못된 사례
100+
이때 일반적으로 사용되는 패턴은 일반 자바스크립트 객체를 전달하는 것이다.
101+
```
102+
103+
## 어색하지 않다면 단수형을 사용합시다
104+
105+
원래 우리말에서는 `~들`이라는 복수형 표현을 그리 널리 사용하지 않습니다. 물론 문장의 의미에 따라 반드시 복수의 객체임을 명시해야 할 때가 있긴 하지만, 그 외의 경우라면 단수형으로 표현하는 편이 대체로 자연스럽습니다.
106+
107+
```text
108+
🇬🇧 The examples below demonstrate the differences.
109+
110+
👍모범 사례
111+
아래 예시는 위에서 언급한 차이점을 보여줍니다.
112+
113+
👍모범 사례 - 복수형 표현이 필요한 경우
114+
아래 예시는 위에서 언급한 여러 차이점을 보여줍니다.
115+
116+
👎잘못된 사례
117+
아래 예시들은 위에서 언급한 차이점들을 보여줍니다.
118+
```
119+
120+
## If는 생략할 수도 있습니다
121+
122+
`If`로 시작하는 문장의 번역이 항상 `만약`으로 시작할 필요는 없습니다. 틀린 번역은 아니지만 한국어에서는 `~한다면`이라는 어미가 이미 조건 또는 상황의 가정을 의미하므로 때로는 `만약`이 없어도 충분히 말이 됩니다. 아래 예시는 인접한 두 문장이 모두 `만약`으로 시작하고 있었습니다. 한 문장 만이라도 `만약`을 생략하면 조금 더 읽기 수월해집니다.
123+
124+
```text
125+
🇬🇧If you load React from a `<script>` tag, .... If you use ES6 with npm, ...
126+
127+
👍모범 사례
128+
React를 <script> 태그로 불러온다면 ... ES6와 npm을 함께 사용한다면 ...
129+
130+
👎잘못된 사례
131+
만약 React를 <script> 태그로 불러온다면 ... 만약 ES6와 npm을 함께 사용한다면 ...
132+
```
File renamed without changes.

0 commit comments

Comments
 (0)