CONTRIBUTING.md 및 TRANSLATION_GUIDE.md 개선 (#378)

* Update CONTRIBUTING.md

컨트리뷰톤 기여자들의 내용 추가

* 기여하기 및 번역 가이드 문서 개선 - PR 만들기 / 리뷰하기 / 번역 규칙 추가

Co-authored-by: Junghwan Park <[email protected]>

Author: hyoyoung

CONTRIBUTING.md

@@ -2,6 +2,7 @@
 
 PyTorch 한국어 튜토리얼 저장소에 방문해주셔서 감사합니다. 이 문서는 PyTorch 한국어 튜토리얼에 기여하는 방법을 안내합니다.
 
+
 ## 기여하기 개요
 
 [본 저장소](https://github.com/9bow/PyTorch-tutorials-kr)는 [PyTorch 공식 튜토리얼](https://pytorch.org/tutorials/)을 번역하는 프로젝트를 위한 곳으로,
@@ -18,17 +19,67 @@ PyTorch 한국어 튜토리얼 저장소에 방문해주셔서 감사합니다.
 * ~[4. 공식 튜토리얼 내용을 반영하는 기여](#4-공식-튜토리얼-내용을-반영하는-기여)~
   * ~[공식 튜토리얼 저장소](https://github.com/pytorch/tutorials)의 내용을 [한국어 튜토리얼 저장소](https://github.com/9bow/PyTorch-tutorials-kr)에 반영하는 기여입니다.~
 
+
 ## 기여 결과물의 라이선스 동의
 
 PyTorch 한국어 튜토리얼은 [공식 튜토리얼 저장소](https://github.com/pytorch/tutorials)와 동일한 [BSD 3항 라이선스](https://github.com/9bow/PyTorch-tutorials-kr/blob/master/LICENSE)를 따릅니다. \
 따라서 기여하신 모든 내용에 [BSD 3항 라이선스](https://github.com/9bow/PyTorch-tutorials-kr/blob/master/LICENSE)가 적용됨을 인지하시고 동의하시는 경우에만 아래 문서 내용과 같이 기여해주세요.
 
+
 ## 기여하기 절차
 
 모든 기여는 [본 저장소에 이슈](https://github.com/9bow/PyTorch-tutorials-kr/issues/new)를 남긴 후 [Pull Request를 보내는 것](https://github.com/9bow/PyTorch-tutorials-kr/pulls)으로 합니다. \
 이 과정을 통해 Pull Request를 위한 Commit을 만들기 전에 이슈를 통해 해당 내용에 기여가 필요한지 여부를 확인하고 협의하셔야 합니다. \
 (물론 이슈를 남기셨다고 해서 반드시 해당 문제를 개선하셔야 하는 것은 아니니, 마음 편히 이슈를 남겨주세요. :))
 
+### Pull Reqeust 만들기
+
+#### Pull Request 만들기 전 : 주의사항
+
+* 하나의 commit, branch, Pull Request(PR)에는 하나의 변경 사항만 담아주세요.
+  * 여러 수정사항에 대해서는 각각 다른 branch에서 작업하신 뒤, 새로운 PR을 만들어주세요.
+  * 새로운 branch가 아닌, 이미 PR를 만드셨던 branch에 추가 commit 시에는 이전 commit들과 함께 Pull Request가 생성됩니다.
+* Pull Request를 만들기 문법 오류나 깨진 글자는 없는지 확인해주세요.
+  * 기본적인 문법은 [Quick reStructredText](https://docutils.sourceforge.io/docs/user/rst/quickref.html) 등의 문서를 참고하여 익혀주세요.
+  * 이미 번역된 문서들을 참고하셔도 좋습니다. (예. \` 뒤에 한글 작성 시 공백 또는 \\이 필요합니다.)
+  * 번역 후에는 `make html-noplot` 등의 명령어로 문법 오류를 확인해주세요.
+    * 번역 결과물에 \`, * 또는 _ 등의 기호를 검색하면 자주 실수하는 문법 오류를 쉽게 찾을 수 있습니다.
+* 오류가 많거나 다른 PR의 commit이 섞여있는 경우 해당 PR은 관리자가 닫을 수 있으니 주의해주세요.
+
+#### Pull Request 만들기 : 생성하기
+
+* `라이선스 동의` 체크하기 ✅
+  * 기여해주신 내용을 더 많은 분들이 참고 / 개선 / 변경할 수 있게 라이선스 적용에 동의해주세요.
+  * 동의를 거부하실 수 있으나, 이 경우 해당 PR의 내용의 자유로운 사용이 어렵기 때문에 리뷰 및 반영은 진행하지 않습니다.
+* PR 내용에 관련 이슈 번호 적어주기 🔢
+  * 논의된 내용이 있다면 참고할 수 있도록 어떠한 이슈로부터 생성한 PR인지 알려주세요.
+* PR 종류 선택하기
+  * 리뷰어에게 어떤 종류의 PR인지 알려주세요.
+* PR 설명하기
+  * 이 PR을 통해 어떠한 것들이 변경되는지 알려주세요.
+* **Tip**: 만약 문서가 방대해서 중간 피드백이 필요하다면 Draft PR 기능을 사용할 수 있습니다.
+  * 자세한 내용은 [GitHub Blog](https://github.blog/2019-02-14-introducing-draft-pull-requests/)의 글을 참고해주세요.
+
+#### Pull Request 만든 후 : 리뷰를 받았을 때
+
+* 리뷰 내용에 대한 추가 의견이 있을 경우 해당 리뷰에 댓글로 의견을 주고 받습니다.
+  * 번역한 문서의 내용은 번역자가 가장 잘 알고 있으므로 리뷰어의 의견에 반드시 따라야 하는 것은 아닙니다.
+  * 하지만 번역 실수나 오류, 잘못된 reStructuredText 문법에 대한 내용은 가급적 반영해주시기를 부탁드립니다.
+  * 다른 문서들과의 일관성, 이해를 위해 추가로 요청드리는 내용들도 있을 수 있으니 감안해주세요.
+* 변경 사항을 고치기로 하였다면, Pull Request를 만든 원본 저장소 / branch에 추가 commit을 합니다.
+  * 리뷰 결과를 반영한 경우 `Resolve Conversation` 버튼을 눌러 리뷰어에게 알립니다.
+
+### Pull Request 리뷰하기
+
+* 리뷰 전 [TRANSLATION_GUIDE.md](TRANSLATION_GUIDE.md) 문서를 읽고 리뷰해주세요.
+* 특히 다음의 내용들을 유의해주세요.
+  * 번역된 용어들이 용어집에 맞게 사용되었는지 확인합니다.
+  * 번역된 내용에 오탈자가 있는지 확인해 봅니다.
+  * 부자연스러운 내용이 있다면 좀 더 나은 번역으로 제안하여 봅니다.
+  * reStructuredText 문법에 맞게 잘 작성되어있는지 확인해 봅니다.
+* 말하려는 내용이 이미 다른 댓글에 있다면 공감 이모지 눌러주세요.
+
+
 ## (기여 종류에 따른) 기여 방법
 
 ### 1. 오탈자를 수정하거나 번역을 개선하는 기여
@@ -66,10 +117,11 @@ reStructuredText 문법에 익숙하지 않은 경우, 다른 튜토리얼의 
 이 과정에서 수정한 문서 상에서 발생하는 오류가 있다면 [reStructuredText 문법](http://docutils.sourceforge.net/docs/user/rst/quickref.html)을 참고하여 올바르게 고쳐주세요. \
 빌드 결과물은 `_build/html` 디렉토리 아래의 경로 / 문서에서 확인하실 수 있습니다.
 
-#### 1-6. Pull Request 남기기
+#### 1-6. Pull Request 만들기
 
 수정을 완료한 내용을 복제한 저장소에 Commit 및 Push하고, Pull Request를 남깁니다. \
-Pull Request가 처음이시라면 [GitHub의 Pull Request 소개 도움말](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) 및 [복제한 저장소로부터 Pull Request 만들기 도움말](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)을 참조해주세요.
+Pull Request를 만드시기 전에 이 문서에 포함된 [Pull Request 만들기](#Pull-Request-만들기) 부분을 반드시 읽어주세요. \
+만약 Pull Request 만들기가 처음이시라면 [GitHub의 Pull Request 소개 도움말](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) 및 [복제한 저장소로부터 Pull Request 만들기 도움말](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)을 참조해주세요.
 
 ### 2. 번역되지 않은 튜토리얼을 번역하는 기여
 
@@ -108,17 +160,19 @@ reStructuredText 문법에 익숙하지 않은 경우, 다른 튜토리얼의 
 이 과정에서 수정한 문서 상에서 발생하는 오류가 있다면 [reStructuredText 문법](http://docutils.sourceforge.net/docs/user/rst/quickref.html)을 참고하여 올바르게 고쳐주세요. \
 빌드 결과물은 `_build/html` 디렉토리 아래의 경로 / 문서에서 확인하실 수 있습니다.
 
-#### 2-6. Pull Request 남기기
+#### 2-6. Pull Request 만들기
 
 번역을 완료한 내용을 복제한 저장소에 Commit 및 Push하고, Pull Request를 남깁니다. \
-Pull Request가 처음이시라면 [GitHub의 Pull Request 소개 도움말](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) 및 [복제한 저장소로부터 Pull Request 만들기 도움말](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)을 참조해주세요.
+Pull Request를 만드시기 전에 이 문서에 포함된 [Pull Request 만들기](#Pull-Request-만들기) 부분을 반드시 읽어주세요. \
+만약 Pull Request 만들기가 처음이시라면 [GitHub의 Pull Request 소개 도움말](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) 및 [복제한 저장소로부터 Pull Request 만들기 도움말](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)을 참조해주세요
 
 ### 3. 2로 번역된 문서를 리뷰하는 기여
 
 [본 저장소에 Pull Request된 튜토리얼 문서](https://github.com/9bow/PyTorch-tutorials-kr/pulls)를 리뷰하는 기여입니다.
 
 Pull Request된 문서의 오탈자 수정, reStructuredText 문법 오류 또는 잘못 번역된 내용을 개선하는 기여로, 가장 기다리고 있는 기여 방식입니다. :pray: \
-PR 리뷰가 익숙하지 않으시다면 [GitHub의 Pull Request 리뷰 관련 도움말](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews)을 참조해주세요.
+Pull Request를 리뷰하시기 전에 이 문서에 포함된 [Pull Request 리뷰하기](#Pull-Request-리뷰하기) 부분을 반드시 읽어주세요. \
+만약 PR 리뷰가 익숙하지 않으시다면 [GitHub의 Pull Request 리뷰 관련 도움말](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews)을 참조해주세요.
 
 ### 4. 공식 튜토리얼 내용을 반영하는 기여
 

TRANSLATION_GUIDE.md

@@ -1,15 +1,46 @@
-# 번역 규칙
-첫번째로 해당 용어가 출현하였을 때는 '한글(영어)'로 번역하고, 이후부터는 한글로만 번역합니다. (예. including transposing, indexing, ... => 전치(transposing), 인덱싱(indexing), ...)		
+# 일반 규칙
 
+* 번역된 문서만으로도 내용을 이해할 수 있도록 문서를 번역해야 합니다.
+  * 기계적인 번역이나 피상적인 리뷰는 지양해주세요.
+  * 일반 명사와 Class 이름은 구분하여 번역을 하거나 원문을 표기합니다. (예. 데이터셋과 Dataset)
 
-# 용어 사용 규칙
-1. 아래 용어가 적절하면 아래 표의 용어를 사용합니다.
-1. 지정된 용어가 없다면 아래 사이트를 참고하여 사용합니다.
-* http://www.ktword.co.kr/ 
-* https://github.com/keunwoochoi/machine_learning_eng2kor/blob/master/dictionary.md
+* 반드시 1:1로 번역하지 않아도 됩니다.
+  * 이해를 돕기 위한 (약간의) 의역이나 설명을 추가해도 좋습니다.
+    * 단, 원문의 의미가 다르게 해석될 여지가 있는 경우에는 자제해주세요.
+  * 문장 단위는 쉬운 유지보수를 위해 가급적 지켜주시기를 요청드립니다.
+    * 하지만 문장이 여러 줄에 걸쳐 조각나 있는 경우 등에는 한 줄에 하나의 문장으로 모아주셔도 됩니다.
+
+* 의미없는 주어는 생략해주세요.
+  * 예를 들어, `we`는 강조의 의미가 있지 않는 이상 번역하지 않고 생략합니다.
+
+* 기본적인 reStructuredText 문법은 숙지해주세요.
+  * [Quick reStructredText](https://docutils.sourceforge.io/docs/user/rst/quickref.html) 등의 문서를 참고하여 문법을 익혀주세요.
+  * 이미 번역된 문서들을 참고하셔도 좋습니다. (예. \` 뒤에 한글 작성 시 공백 또는 \\이 필요합니다.)
+  * 번역 후에는 `make html-noplot` 등의 명령어로 문법 오류를 확인해주세요.
+    * 번역 결과물에 \`, * 또는 _ 등의 기호를 검색하면 자주 실수하는 문법 오류를 쉽게 찾을 수 있습니다.
+
+* 번역된 문장만으로 의미를 전달하기 어려울 때에는 `한글(영어)`와 같이 작성합니다.
+  * 제목과 본문에 각각 사용되는 경우 첫번째로 해당 용어가 출현하였을 때 매번 함께 작성합니다.
+    * 예. including transposing, indexing, ... => 전치(transposing), 인덱싱(indexing), ...
+  * 가급적 한 번씩만 함께 작성하는 것을 원칙으로 하지만 번역자가 임의로 여러번 함께 작성할 수 있습니다.
+    * 예. 직렬화(Serialize)
 
- 없으면 적절한 단어를 사용하고, 아래 목록에 내용을 추가합니다. 				
+* 소스 코드, 논문 제목, 출력 결과 등은 가급적 번역하지 않습니다.
+  * 단, 소스 코드에 포함된 주석은 가급적 번역합니다.
+  * 원문을 함께 찾아볼 필요가 있는 논문 제목 등은 번역 시 전체 원문을 함께 작성합니다.
+  * 명령어의 출력 결과, 로그(log) 등은 결과 비교를 위해 번역하지 않습니다.
 
+* 줄바꿈 및 공백은 가급적 원문과 동일하게 유지합니다.
+  * 이후 원본 문서에 추가적인 변경이 발생할 때 유지보수를 돕습니다.
+  * 너무 긴 문장은 reStructuredText 문법을 지키는 선에서 줄바꿈을 추가해도 좋습니다.
+
+# 용어 사용 규칙
+
+1. 아래 용어가 적절하면 가급적 아래 표의 용어를 사용합니다.
+1. 지정된 용어가 없다면 아래 사이트를 참고하여 사용합니다.
+  * http://www.ktword.co.kr/
+  * https://github.com/keunwoochoi/machine_learning_eng2kor/blob/master/dictionary.md
+1. 적절한 용어가 없으면 적절한 단어를 새로 사용하고, 아래 목록에 내용을 추가합니다.
 
 |영문|한글|작성자|추가 설명|
 |---|---|:---:|---|