# (Hands-on) PyTorch 한국어 튜토리얼 기여하기

## 번역하기

### reStructuredText 문법

1. [제목](https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/CommonPitfalls/Headers.html#correct-syntax) : 글자 수에 맞게 =을 추가해주세요 (- / *도 마찬가지로 적용)
> 옳은 문법

================
This Is a Header
================

Another Header
==============


This Is Also Correct but Not Recommended
======================================================

> 틀린 문법

Another Header
------------

2. [특수 텍스트](https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/InlineCode.html?highlight=math#using-text-roles)는 다음과 같이 작성하시면 됩니다.
> 수식

:math:`f(x)`

3. [하이퍼링크](https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/CommonPitfalls/Hyperlinks.html#correct-syntax)는 다음과 같이 작성하시면 됩니다.

`anchor text <url>`__

4. [인덴트](https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/CommonPitfalls/Indents.html#common-mistake-1-incorrect-indents)는 원문과 동일해야 합니다.

5. [인라인 스타일링](https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/CommonPitfalls/InlineStyle.html#correct-syntax)도 유의해주세요.

6. [불렛 포인트](https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/CommonPitfalls/Lists.html#correct-syntax)도 유의해주세요.

<br>

### 번역 스타일링

1. 주어는 생략해주세요! 예를 들어, we는 강조의 의미가 있지 않는 이상 해석할 필요 없습니다.

원본 : For this tutorial, we will be using a TorchVision DataSet

번역 : 이 튜토리얼에서는 TorchVision 데이터셋을 사용하겠습니다

2. 조사 ~으로, ~통해서 등을 restructure로 쓰다보면 새로운 줄에 생기는 경우가 있습니다.

3. 번역을 할 때 되게 긴 문장이 있으면 한 줄에 입력해도 상관은 없지만, 유지 관리하는 입장에서 두개줄로 보기 편하게 쪼개는 것이 중요합니다.

4. 처음 등장하는 애매한 단어는 원문을 함께 사용하셔도 좋습니다. (예: 직렬화(Serialize))

5. 피상적인 리뷰, 기계적인 리뷰를 지양합니다.

6. Class 이름과 일반 명사는 가급적 다르게 번역합니다. (예: `Dataset`과 데이터셋)

7. PyTorch 번역 문서는 용어를 약속하여 번역을 올리고 있습니다. 번역할 단어가 용어집에 있는지 확인 후 번역해주세요!

8. 줄내림과 공백을 원문대로 지켜주세요.

<br>

## 💌 Pull Request 보내는 방법

### 1️⃣ PR 보내기 전 : 주의사항

* 하나의 commit, branch, PR 에는 하나의 수정내용에 대해서만 작성해주세요.
* 여러 수정사항에 대해서는 각각 다른 branch에서 작업하신 후 PR을 다르게 보내주세요.
* 새로운 브랜치 생성을 하지 않고 Pull Request를 날린 이후 커밋을 날리면 이전 커밋과 함께 Pull Request에 올라갑니다.
* 컴파일 안하고 Pull Request 했을 때 글자가 깨지는 경우가 있습니다. 반드시 빌드해보고 수정된 결과를 확인한 후 문제가 없을 경우에 보내주세요.

### 2️⃣ PR 보내기 : Create Pull Request

* 라이선스 동의 체크하기 ✅
* PR 내용에 관련 이슈 번호 적어주기 🔢
* PR 종류 선택하기
* PR 설명하기

> TIP : 만약 문서가 방대해서 중간 피드백이 필요하다면 [*Draft PR*](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests) 을 이용해보세요!

### 3️⃣ PR 보낸 후 : 리뷰를 받았을 때

* 댓글 내용을 반영해서 수정한 후 commit 합니다.
* 문제가 해결된 댓글들은 Resolve Conversation을 눌러서 축소시킵니다.
* 피드백에 대해 의논이 필요한 경우 댓글로 의견을 주고 받습니다.

### ▶ PR 리뷰는 이렇게 해주세요

* 번역된 용어들이 용어집에 맞게 사용되었는지 확인해보기
* 번역된 내용에 오탈자가 있는지 확인해보기
* 부자연스러운 내용이 있다면 좀 더 나은 번역으로 제안해보기
* reStructuredText 문법에 맞게 잘 작성되어있는지 확인해보기
* 말하려는 내용이 이미 Review 댓글에 있다면 공감 이모지 눌러주기!