From 989aed70b1156b8fc0bf66ba368df0261fe15953 Mon Sep 17 00:00:00 2001 From: Taehwan Noh Date: Sun, 10 Feb 2019 13:53:55 +0900 Subject: [PATCH 1/6] Add english style guide --- UNIVERSAL-STYLE-GUIDE.md | 99 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 99 insertions(+) create mode 100644 UNIVERSAL-STYLE-GUIDE.md diff --git a/UNIVERSAL-STYLE-GUIDE.md b/UNIVERSAL-STYLE-GUIDE.md new file mode 100644 index 000000000..b0713cff4 --- /dev/null +++ b/UNIVERSAL-STYLE-GUIDE.md @@ -0,0 +1,99 @@ +# Universal Style Guide + +This repo describes rules that should be applied to **all** languages. + +NOTE TO MAINTAINERS: You may want to translate this guide so that it can be more accessible to your translators. + +## Heading IDs + +All headings have explicit IDs like this: + +```md +## Try React {#try-react} +``` + +Do **not** translate these IDs! They are used for navigation and will break if the document is referred to externally, i.e.: + +```md +See the [beginning section](/getting-started#try-react) for more information. +``` + +✅ DO: + +```md +## Prueba React {#try-react} +``` + +❌ DON'T: + +```md +## Prueba React {#prueba-react} +``` + +This will break the link above. + +## Text in Code Blocks + +Leave text in code blocks untranslated except for comments. You may optionally translate text in strings, but be careful not to translate strings that refer to code! + +Example: +```js +// Example +const element =

Hello, world

; +ReactDOM.render(element, document.getElementById('root')); +``` + +✅ DO: + +```js +// Ejemplo +const element =

Hello, world

; +ReactDOM.render(element, document.getElementById('root')); +``` + +✅ ALSO OKAY: + +```js +// Ejemplo +const element =

Hola mundo

; +ReactDOM.render(element, document.getElementById('root')); +``` + +❌ DON'T: + +```js +// Ejemplo +const element =

Hola mundo

; +// "root" refers to an element ID. +// DO NOT TRANSLATE +ReactDOM.render(element, document.getElementById('raíz')); +``` + +❌ DEFINITELY DON'T: + +```js +// Ejemplo +const elemento =

Hola mundo

; +ReactDOM.hacer(elemento, documento.obtenerElementoPorId('raíz')); +``` + +## External Links + +If an external link is to an article in a reference like [MDN] or [Wikipedia], and a version of that article exists in your language that is of decent quality, consider linking to that version instead. + +[MDN]: https://developer.mozilla.org/en-US/ +[Wikipedia]: https://en.wikipedia.org/wiki/Main_Page + +Example: + +```md +React elements are [immutable](https://en.wikipedia.org/wiki/Immutable_object). +``` + +✅ OK: + +```md +Los elementos de React son [inmutables](https://es.wikipedia.org/wiki/Objeto_inmutable). +``` + +For links that have no equivalent (Stack Overflow, YouTube videos, etc.), just use the English link. From 4374ed49df6080e4a10e0ead652a4735632af4aa Mon Sep 17 00:00:00 2001 From: Taehwan Noh Date: Sun, 10 Feb 2019 23:50:25 +0900 Subject: [PATCH 2/6] Translate to Korean --- UNIVERSAL-STYLE-GUIDE.md | 58 +++++++++++++++++++--------------------- 1 file changed, 28 insertions(+), 30 deletions(-) diff --git a/UNIVERSAL-STYLE-GUIDE.md b/UNIVERSAL-STYLE-GUIDE.md index b0713cff4..6c9357a68 100644 --- a/UNIVERSAL-STYLE-GUIDE.md +++ b/UNIVERSAL-STYLE-GUIDE.md @@ -1,42 +1,40 @@ -# Universal Style Guide +# 공통 스타일 가이드 -This repo describes rules that should be applied to **all** languages. +이 문서는 **모든** 언어에 적용돼야 할 규칙을 설명합니다. -NOTE TO MAINTAINERS: You may want to translate this guide so that it can be more accessible to your translators. +## 제목 아이디 -## Heading IDs - -All headings have explicit IDs like this: +모든 제목은 다음처럼 명시적인 아이디를 가집니다. ```md ## Try React {#try-react} ``` -Do **not** translate these IDs! They are used for navigation and will break if the document is referred to externally, i.e.: +**아이디는 번역하면 안 됩니다!** 이 아이디는 탐색을 위해 사용되며 아래처럼 외부에서 문서가 참조될 때 유효하지 않을 수 있습니다. ```md -See the [beginning section](/getting-started#try-react) for more information. +자세한 내용은 [시작 부분](/getting-started#try-react)을 참조해주세요. ``` ✅ DO: ```md -## Prueba React {#try-react} +## React 시도해보기 {#try-react} ``` ❌ DON'T: ```md -## Prueba React {#prueba-react} +## React 시도해보기 {#react-시도해보기} ``` -This will break the link above. +이는 위에 있는 링크가 유효하지 않게 만듭니다. -## Text in Code Blocks +## 코드에 있는 문자 -Leave text in code blocks untranslated except for comments. You may optionally translate text in strings, but be careful not to translate strings that refer to code! +주석을 제외한 모든 코드는 번역하지 않고 그대로 놔둬 주세요. 선택적으로 문자열에 있는 텍스트를 수정할 수 있지만, 코드로 활용되는 문자열은 번역하지 않도록 주의해주세요. -Example: +예를 든다면 ```js // Example const element =

Hello, world

; @@ -46,7 +44,7 @@ ReactDOM.render(element, document.getElementById('root')); ✅ DO: ```js -// Ejemplo +// 예시 const element =

Hello, world

; ReactDOM.render(element, document.getElementById('root')); ``` @@ -54,37 +52,37 @@ ReactDOM.render(element, document.getElementById('root')); ✅ ALSO OKAY: ```js -// Ejemplo -const element =

Hola mundo

; +// 예시 +const element =

안녕 세상

; ReactDOM.render(element, document.getElementById('root')); ``` ❌ DON'T: ```js -// Ejemplo -const element =

Hola mundo

; -// "root" refers to an element ID. -// DO NOT TRANSLATE -ReactDOM.render(element, document.getElementById('raíz')); +// 예시 +const element =

안녕 세상

; +// "root"는 HTML 엘리먼트의 아이디를 의미합니다. +// 번역하지 마세요. +ReactDOM.render(element, document.getElementById('뿌리')); ``` ❌ DEFINITELY DON'T: ```js -// Ejemplo -const elemento =

Hola mundo

; -ReactDOM.hacer(elemento, documento.obtenerElementoPorId('raíz')); +// 예시 +const 요소 =

안녕 세상

; +ReactDOM.그리다(요소, 문서.아이디로부터_엘리먼트_가져오기('뿌리')); ``` -## External Links +## 외부 링크 -If an external link is to an article in a reference like [MDN] or [Wikipedia], and a version of that article exists in your language that is of decent quality, consider linking to that version instead. +외부 링크가 [MDN] 또는 [Wikipedia]의 문서를 참조하고 같은 문서의 번역본이 괜찮은 품질이라면 번역된 문서를 참조할지 고려해보세요. [MDN]: https://developer.mozilla.org/en-US/ [Wikipedia]: https://en.wikipedia.org/wiki/Main_Page -Example: +예를 든다면 ```md React elements are [immutable](https://en.wikipedia.org/wiki/Immutable_object). @@ -93,7 +91,7 @@ React elements are [immutable](https://en.wikipedia.org/wiki/Immutable_object). ✅ OK: ```md -Los elementos de React son [inmutables](https://es.wikipedia.org/wiki/Objeto_inmutable). +React 엘리먼트는 [불변객체](https://ko.wikipedia.org/wiki/%EB%B6%88%EB%B3%80%EA%B0%9D%EC%B2%B4)입니다. ``` -For links that have no equivalent (Stack Overflow, YouTube videos, etc.), just use the English link. +외부 링크의 번역본이 없다면 (Stack Overflow, YouTube 비디오 등) 영어 링크를 사용해주세요. From 3b3a8dbd79579340c78a0e5e37ebe2a215805376 Mon Sep 17 00:00:00 2001 From: Taehwan Noh Date: Mon, 11 Feb 2019 12:12:41 +0900 Subject: [PATCH 3/6] Apply review comment --- UNIVERSAL-STYLE-GUIDE.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/UNIVERSAL-STYLE-GUIDE.md b/UNIVERSAL-STYLE-GUIDE.md index 6c9357a68..e38b3c33b 100644 --- a/UNIVERSAL-STYLE-GUIDE.md +++ b/UNIVERSAL-STYLE-GUIDE.md @@ -4,25 +4,25 @@ ## 제목 아이디 -모든 제목은 다음처럼 명시적인 아이디를 가집니다. +모든 제목에는 다음과 같이 아이디가 명시적으로 설정되어 있습니다. ```md ## Try React {#try-react} ``` -**아이디는 번역하면 안 됩니다!** 이 아이디는 탐색을 위해 사용되며 아래처럼 외부에서 문서가 참조될 때 유효하지 않을 수 있습니다. +**아이디는 번역하면 안 됩니다!** 이 아이디는 탐색을 위해 사용되므로 번역하면 아래처럼 외부에서 문서가 참조될 때 링크가 깨질 수 있습니다. ```md 자세한 내용은 [시작 부분](/getting-started#try-react)을 참조해주세요. ``` -✅ DO: +✅ 권장 ```md ## React 시도해보기 {#try-react} ``` -❌ DON'T: +❌ 금지: ```md ## React 시도해보기 {#react-시도해보기} @@ -32,16 +32,16 @@ ## 코드에 있는 문자 -주석을 제외한 모든 코드는 번역하지 않고 그대로 놔둬 주세요. 선택적으로 문자열에 있는 텍스트를 수정할 수 있지만, 코드로 활용되는 문자열은 번역하지 않도록 주의해주세요. +주석을 제외한 모든 코드는 번역하지 않고 그대로 놔둬 주세요. 선택적으로 문자열에 있는 텍스트를 수정할 수 있지만, 코드를 참조하는 문자열은 번역하지 않도록 주의해주세요. -예를 든다면 +예시는 다음과 같습니다. ```js // Example const element =

Hello, world

; ReactDOM.render(element, document.getElementById('root')); ``` -✅ DO: +✅ 권장 ```js // 예시 @@ -49,7 +49,7 @@ const element =

Hello, world

; ReactDOM.render(element, document.getElementById('root')); ``` -✅ ALSO OKAY: +✅ 허용: ```js // 예시 @@ -57,7 +57,7 @@ const element =

안녕 세상

; ReactDOM.render(element, document.getElementById('root')); ``` -❌ DON'T: +❌ 금지: ```js // 예시 @@ -67,7 +67,7 @@ const element =

안녕 세상

; ReactDOM.render(element, document.getElementById('뿌리')); ``` -❌ DEFINITELY DON'T: +❌ 절대 금지: ```js // 예시 @@ -77,21 +77,21 @@ ReactDOM.그리다(요소, 문서.아이디로부터_엘리먼트_가져오기(' ## 외부 링크 -외부 링크가 [MDN] 또는 [Wikipedia]의 문서를 참조하고 같은 문서의 번역본이 괜찮은 품질이라면 번역된 문서를 참조할지 고려해보세요. +외부 링크가 [MDN]이나 [Wikepedia]같은 참고 문헌의 문서에 연결되어 있고 해당 문서가 자국어로 잘 번역되어 있다면 번역 문서를 링크하는 것도 고려해보세요. [MDN]: https://developer.mozilla.org/en-US/ [Wikipedia]: https://en.wikipedia.org/wiki/Main_Page -예를 든다면 +예시는 다음과 같습니다. ```md React elements are [immutable](https://en.wikipedia.org/wiki/Immutable_object). ``` -✅ OK: +✅ 허용: ```md React 엘리먼트는 [불변객체](https://ko.wikipedia.org/wiki/%EB%B6%88%EB%B3%80%EA%B0%9D%EC%B2%B4)입니다. ``` -외부 링크의 번역본이 없다면 (Stack Overflow, YouTube 비디오 등) 영어 링크를 사용해주세요. +외부 링크를 대체할 만한 자국어 자료가 없다면 (Stack Overflow, YouTube 비디오 등) 영어 링크를 사용해주세요. From a05f6c6b1eeb034828990b6ece8f114ce6449ee6 Mon Sep 17 00:00:00 2001 From: Taehwan Noh Date: Mon, 11 Feb 2019 12:19:59 +0900 Subject: [PATCH 4/6] Fix typo --- UNIVERSAL-STYLE-GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/UNIVERSAL-STYLE-GUIDE.md b/UNIVERSAL-STYLE-GUIDE.md index e38b3c33b..aacbdaa29 100644 --- a/UNIVERSAL-STYLE-GUIDE.md +++ b/UNIVERSAL-STYLE-GUIDE.md @@ -77,7 +77,7 @@ ReactDOM.그리다(요소, 문서.아이디로부터_엘리먼트_가져오기(' ## 외부 링크 -외부 링크가 [MDN]이나 [Wikepedia]같은 참고 문헌의 문서에 연결되어 있고 해당 문서가 자국어로 잘 번역되어 있다면 번역 문서를 링크하는 것도 고려해보세요. +외부 링크가 [MDN]이나 [Wikipedia]같은 참고 문헌의 문서에 연결되어 있고 해당 문서가 자국어로 잘 번역되어 있다면 번역 문서를 링크하는 것도 고려해보세요. [MDN]: https://developer.mozilla.org/en-US/ [Wikipedia]: https://en.wikipedia.org/wiki/Main_Page From eddec3dbe26fbf5462481a425f3cf829f4e501f7 Mon Sep 17 00:00:00 2001 From: Taehwan Noh Date: Mon, 11 Feb 2019 21:55:14 +0900 Subject: [PATCH 5/6] Update link --- UNIVERSAL-STYLE-GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/UNIVERSAL-STYLE-GUIDE.md b/UNIVERSAL-STYLE-GUIDE.md index aacbdaa29..22aed344e 100644 --- a/UNIVERSAL-STYLE-GUIDE.md +++ b/UNIVERSAL-STYLE-GUIDE.md @@ -91,7 +91,7 @@ React elements are [immutable](https://en.wikipedia.org/wiki/Immutable_object). ✅ 허용: ```md -React 엘리먼트는 [불변객체](https://ko.wikipedia.org/wiki/%EB%B6%88%EB%B3%80%EA%B0%9D%EC%B2%B4)입니다. +React 엘리먼트는 [불변객체](https://ko.wikipedia.org/wiki/불변객체)입니다. ``` 외부 링크를 대체할 만한 자국어 자료가 없다면 (Stack Overflow, YouTube 비디오 등) 영어 링크를 사용해주세요. From 55b18eb864e2a6f5890adbc55573395a00a17f8a Mon Sep 17 00:00:00 2001 From: Taehwan Noh Date: Tue, 12 Feb 2019 22:42:52 +0900 Subject: [PATCH 6/6] Unify translation of 'break' --- UNIVERSAL-STYLE-GUIDE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/UNIVERSAL-STYLE-GUIDE.md b/UNIVERSAL-STYLE-GUIDE.md index 22aed344e..4fbf29d7b 100644 --- a/UNIVERSAL-STYLE-GUIDE.md +++ b/UNIVERSAL-STYLE-GUIDE.md @@ -28,7 +28,7 @@ ## React 시도해보기 {#react-시도해보기} ``` -이는 위에 있는 링크가 유효하지 않게 만듭니다. +이는 위에 있는 링크를 깨지게 만듭니다. ## 코드에 있는 문자