번역 가이드
jhonghee opened this issue · comments
번역 가이드라인을 정해 주십시요.
- 번역글 상단에 "번역자: <이름>" 을 남겨주십시요.
- 번역글을 작성하실때 한 문단 단위로 나누어 하시길 권장합니다. Proof reading이 끝날때 까지는 원문을 그대로 남겨두시고 원문 문단 바로 밑에 번역 문단을 작성하시면 Proof Reading을 원할히 진행할 수 있습니다.
- 원문과 번역문이 서로 분리되어 렌더링되기 위해서 이 둘 사이에는 반드시 하나 이상의 빈줄을 유지해 주셔야 합니다.
- 리스트 번역을 하실 때에는 바로 밑에 번역을 하면 번역문이 영문 리스트에 포함되어 버립니다. 반드시 상위 문단과 함께 묶어 번역해 주세요.
- 맺음말은 "~하다"로 통일하겠습니다.
- 번역 소스는 Markdown으로 작성되어 있습니다. Gitbook에 있는 syntax를 준수해 주십시요.
https://toolchain.gitbook.com/syntax/markdown.html - 단어의 통일을 위해 Glossary를 활용할 방침입니다. 번역에 자신이 없을 경우 Gitter방에 문의해 주시고 의견이 수렴되면 Glossary 페이지에 첨가해 주십시요.
https://github.com/golangkorea/golang-spec/blob/master/GLOSSARY.md - 번역이 애매하거나 어색한 경우는 한글 단어 옆에 괄호로 영어 원문의 단어를 적어주십시요.
- 번역작업도 중요하지만 함께 작업하시는 분들의 내용을 Proof reading하는데 동참해 주십시요.
- 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로 바꿔주시면 됩니다. 깃헙의 공식 도움말을 참조하십시요
일단 싱크되면 본인의 forked repo에 다시 푸쉬하십시요.
git push -f origin master
8번과 관련해서 go 버전 넘버도 섹션에 포함하면 어떨까요? 번역자 이름 아래 정도에 위치시키면 작업 추적하는데 도움이 될 것 같습니다. Effectvie Go 문서를 보니 discussion open 된 것 중에 이미 수정된 것도 많이 보이던데 오탈자/개선은 gitbook discussion보다는 github issue/PR 로 통합관리하는게 효율적일 것 같습니다.
1번과 관련해서 Effective Go의 경우 번역글 첫 부분이 아래 구조로 되어있네요.
*원문 : 영문섹션이름(섹션 링크)
*번역자: 번역자 이름(@id 또는 이메일)
이 형태를 사용해도 괜찮을것 같네요. go 버전 넘버도 추가한다면 글 첫 머리는 아래와 같은 구조가 되겠네요.
- Go 버전: 1.9.2
- 원문: 영문섹션이름(섹션 링크)
- 번역자: 번역자 이름(@githubid 또는 이메일)
요것을 template처럼 번역대상 파일에 한번에 입력해놓으면 편할 거 같습니다.
Go 버전은 둘 중에 하나를 선택할 수 있겠네요.
- Build version go1.9.2(spec 문서 하단에 표기됨)
- Version of June 28, 2017(spec 문서 상단에 표기됨)
Go 버전은 아래 포맷으로 통일했습니다. (README 참고)
* Go 버전: 1.9