afraxas / golang-spec

Go 언어 스펙 한글 번역

golang-spec

Go 언어 스펙 한글 번역

Go 언어 스펙 번역에 참여하실 분들은 아래 링크를 통해 본인이 번역하고자 하는 부분에 이름을 등록하시길 바랍니다.

https://docs.google.com/spreadsheets/d/1R-E_4SM1vGsUiGBLLVilUlahHxC7U1R592E3GLryYKA/edit?usp=sharing

작년에 Effective Go 번역과 마찬가지로 GitHub 저장소를 fork하시고 번역하신 다음 PR을 생성해주시면 됩니다.

번역물은 GitBook에 호스트됩니다.

기본적인 번역 가이드라인에 대한 의견은 issue를 이용해주세요.

번역에 대한 질의 및 토의는 GitHub issue 게시판을 이용해주시기 바랍니다.

Gitter 방도 마련되어 있으니 많은 참여바랍니다.

번역 진행 과정

PR 생성 - Review - Merge - GitBook 포스팅 - Proof of Reading - Issue 생성 - Contents Update(PR)

• PR(pull request)이 생성되면 PR에 대한 review가 진행되며, 이 과정에서 오탈자 확인, 번역문 개선, 의견 교환 등이 이루어집니다.
• review 과정에서 논의된 수정사항들을 반영하여 PR을 업데이트하면 최종적으로 master branch에 merge됩니다.
• GitHub에서 master branch에 merge되면 자동으로 GitBook에 포스팅됩니다.
• GitBook에 포스팅된 이후에 발생하는 번역문 관련 모든 이슈는 GitHub issue로 보고해주시기 바랍니다.
• 번역 참가자(proof of reading 참가자 포함)는 GitBook에서 제공하는 disqus 댓글, discussion 기능 대신 GitHub issue를 이용해주세요.

번역 가이드라인

1. 번역글 상단에 아래와 같이 Go 버전, 원문, 번역자를 추가해주세요.

* Go 버전: 1.9
* 원문: [영문 섹션 이름](영문 문서 주소)
* 번역자: [번역자 이름](@github_ID)

2. header title은 아래 예시와 같이 한글 타이틀 이름, 영문 타이틀 이름, reference id 구조로 번역해주세요. (reference id 작성방법은 아래 6번 항목을 참조하세요.)

# [배열 타입(Array types)](#array-types)

3. 번역글을 작성하실때 한 문단 단위로 나누어 하시길 권장합니다. Proof of Reading이 끝날 때까지는 원문을 그대로 남겨두시고 원문 문단 바로 밑에 번역 문단을 작성하시면 Proof of Reading을 원할히 진행할 수 있습니다.

• 원문과 번역문이 서로 분리되어 렌더링되기 위해서 이 둘 사이에는 반드시 하나 이상의 빈줄을 유지해 주셔야 합니다.
• 리스트 번역을 하실 때에는 바로 밑에 번역을 하면 번역문이 영문 리스트에 포함되어 버립니다. 반드시 상위 문단과 함께 묶어 번역해 주세요.

//번역 예시

//BAD
Comments serve as program documentation. There are two forms:
주석을 이용해 프로그램 문서화를 할 수 있다. 주석은 2가지 형태가 있다:

//GOOD
Comments serve as program documentation. There are two forms:

주석을 이용해 프로그램 문서화를 할 수 있다. 주석은 2가지 형태가 있다:

//BAD
1. *Line comments* start with the character sequence // and stop at the end of the line.
1. *라인 주석*은 //로 시작하며 라인 끝에서 끝난다.
2. *General comments* start with the character sequence /\* and stop with the first subsequent character sequence \*/.
2. *일반 주석*은 /\*로 시작해서 \*/을 처음 만났을 때 끝난다. 

//GOOD
Comments serve as program documentation. There are two forms:

1. *Line comments* start with the character sequence // and stop at the end of the line.
2. *General comments* start with the character sequence /\* and stop with the first subsequent character sequence \*/.

주석을 이용해 프로그램 문서화를 할 수 있다. 주석은 2가지 형태가 있다:

1. *라인 주석*은 //로 시작하며 라인 끝에서 끝난다.
2. *일반 주석*은 /\*로 시작해서 \*/을 처음 만났을 때 끝난다. 

4. 타입 자체가 코드에서 사용되는 경우 string 타입과 같은 형태로 번역하고, 그 외에는 한글 번역을 적용하는 것을 원칙으로 합니다. 이 기준에 따라 타입은 아래와 같이 번역합니다.

불리언 타입, 숫자 타입, string 타입, 배열 타입, 슬라이스 타입, struct 타입, 포인터 타입, 함수 타입, interface 타입, map 타입, 채널 타입

// 번역 예시 
A string type represents the set of string values

string 타입은 문자열 값들의 집합을 표현한다.

5. EBNF에 따라 작성된 Go 문법은 번역하지 않는 것을 원칙으로 합니다.(주석은 번역 가능) 예를 들면, Characters 섹션에 나오는 문법 표현은 아래와 같습니다.

newline        = /* the Unicode code point U+000A */ .
unicode_char   = /* an arbitrary Unicode code point except newline */ .
unicode_letter = /* a Unicode code point classified as "Letter" */ .
unicode_digit  = /* a Unicode code point classified as "Number, decimal digit" */ .

Go 문법 표현은 원문 그대로 유지해 주시길 바라며, /* the Unicode code point U+000A */과 같은 주석은 한글로 번역하셔도 괜찮습니다.

6. 맺음말은 "~하다"로 통일하겠습니다.
7. 번역 소스는 Markdown으로 작성되어 있습니다. GitBook에 있는 syntax를 준수해 주십시요.
8. 본문에서 다른 Markdown 문서의 section을 참조하는 경우 아래 규칙을 참고해서 작성해주세요.

• 본문에서 참조하는 문서의 section header에 reference id가 없으면, 해당 문서의 section header에 reference id를 추가합니다.
• reference id는 section title과 동일한 이름으로 설정하고 section title에 공백이 포함되어 있는 경우 dash(-)를 사용합니다.
• reference id는 소문자로만 작성합니다.

// https://github.com/golangkorea/golang-spec/edit/master/Declarations%20and%20scope/type_declarations.md
## [Type definitions](#type-definitions)

• 본문에서 참조문서의 섹션을 참조하는 링크는 아래와 같이 구성합니다.

// https://github.com/golangkorea/golang-spec/blob/master/Expressions/conversions.md
[defined types](/Declarations%20and%20scope/type_declarations.html#type-definitions)

9. 용어집에서는 자주 사용되는 용어, 번역하기 힘들거나 애매한 용어들에 대한 추천 번역 및 설명을 제공하고 있습니다. GitBook에서는 용어집에 등록된 용어가 본문에 있을 경우, 아래처럼 밑줄, 하이라이트, 팝업창 등의 기능을 제공합니다.(예제에서는 code point가 해당됩니다.)

용어집 용어 추가 건의, 번역 용어에 대한 의견은 용어집 이슈 게시판을 이용해주세요.

10. 번역작업도 중요하지만 함께 작업하시는 분들의 내용을 Proof reading하는데 동참해 주십시요.
11. PR를 한 지 좀 시간이 지나다 보면 그 사이에 golangkorea/golang-spec에 많은 변화가 있을 수 있습니다. 그때는 본인의 로컬 repo를 최신의 golangkorea/golang-spec와 싱크 시킬 필요가 생깁니다. 새로운 포스트를 시작하기 전에 우선 로컬의 repo에 golangkorea/golang-spec를 upstream remote repo로 만드시고 나머지 단계를 따라 싱크 시키십시요.

• Add the remote, call it "upstream":

git remote add upstream https://github.com/golangkorea/golang-spec.git

• Fetch all the branches of that remote into remote-tracking branches, such as upstream/master:

git fetch upstream

• Make sure that you're on your master branch:

git checkout master

• Rewrite your master branch so that any commits of yours that aren't already in upstream/master are replayed on top of that other branch:

git rebase upstream/master

• Merge를 하는 경우에는 rebase를 merge로 바꿔주시면 됩니다. GitHub의 공식 도움말을 참조하십시요. 일단 싱크되면 본인의 forked repo에 다시 푸쉬하십시요.

git push -f origin master