"Go 기여 가이드"의 두 판 사이의 차이

1번째 줄: 1번째 줄:
==개요==
==개요==
;컨트리뷰션 가이드
;기여 가이드


Go 프로젝트는 모든 컨트리뷰터를 환영합니다.
Go 프로젝트는 모든 기여자를 환영합니다.


본 문서는 Go 프로젝트에 컨트리뷰트하는 과정을 안내하는 가이드로, 다른 오픈소스 프로젝트에서 사용하는 방식과 조금 다릅니다. Git과 Go에 대한 기본적인 이해가 있다고 가정합니다.
본 문서는 Go 프로젝트에 기여하는 과정을 안내하는 가이드로, 다른 오픈소스 프로젝트에서 사용하는 방식과 조금 다릅니다. Git과 Go에 대한 기본적인 이해가 있다고 가정합니다.


여기에 있는 정보 외에도 Go 커뮤니티는 [https://go.dev/wiki/CodeReview CodeReview] 위키 페이지를 유지관리합니다. 리뷰 프로세스를 배우면서 자유롭게 위키에 기여해 보세요.
여기에 있는 정보 외에도 Go 커뮤니티는 [https://go.dev/wiki/CodeReview CodeReview] 위키 페이지를 유지관리합니다. 리뷰 프로세스를 배우면서 자유롭게 위키에 기여해 보세요.


gccgo 프론트엔드는 다른 곳에 있습니다 [https://go.dev/doc/gccgo_contribute.html gccgo에 컨트리뷰트하기]를 참조하세요.
gccgo 프론트엔드는 다른 곳에 있습니다 [https://go.dev/doc/gccgo_contribute.html gccgo에 기여하기]를 참조하세요.


==컨트리뷰터 되기==
==기여자 되기==
===개요===
===개요===
첫 번째 단계는 Go 컨트리뷰터로 등록하고 환경을 구성하는 것입니다. 필수 단계의 체크리스트는 다음과 같습니다.
첫 번째 단계는 Go 기여자로 등록하고 환경을 구성하는 것입니다. 필수 단계의 체크리스트는 다음과 같습니다.


* 0단계: Go에 컨트리뷰트하는 데 사용할 단일 Google 계정을 결정합니다. 다음 모든 단계에 해당 계정을 사용하고 git 해당 계정의 이메일 주소로 커밋을 생성하도록 구성되어 있는지 확인하세요.
* 0단계: Go에 기여하는 데 사용할 단일 Google 계정을 결정합니다. 다음 모든 단계에 해당 계정을 사용하고 git 해당 계정의 이메일 주소로 커밋을 생성하도록 구성되어 있는지 확인하세요.
* 1단계: CLA(컨트리뷰터 라이선스 계약)에 [https://cla.developers.google.com/clas 서명하고 제출]합니다 .
* 1단계: CLA(기여자 라이선스 계약)에 [https://cla.developers.google.com/clas 서명하고 제출]합니다 .
* 2단계: Go Git 저장소에 대한 인증 자격증명을 구성합니다. [https://go.googlesource.com/ go.googlesource.com]을 방문하여 페이지 오른쪽 상단 메뉴 표시줄에서 '비밀번호 생성'을 클릭하고 지침을 따르세요.
* 2단계: Go Git 저장소에 대한 인증 자격증명을 구성합니다. [https://go.googlesource.com/ go.googlesource.com]을 방문하여 페이지 오른쪽 상단 메뉴 표시줄에서 '비밀번호 생성'을 클릭하고 지침을 따르세요.
* 3단계: [https://go-review.googlesource.com/login/ 이 페이지]를 방문하여 Go 팀에서 사용하는 코드 리뷰 도구인 Gerrit에 등록하세요. CLA 및 등록은 귀하의 계정에 대해 한 번만 수행하면 됩니다.
* 3단계: [https://go-review.googlesource.com/login/ 이 페이지]를 방문하여 Go 팀에서 사용하는 코드 리뷰 도구인 Gerrit에 등록하세요. CLA 및 등록은 귀하의 계정에 대해 한 번만 수행하면 됩니다.
27번째 줄: 27번째 줄:
</syntaxhighlight>
</syntaxhighlight>


이 장의 나머지 부분에서는 이러한 지침에 대해 자세히 설명합니다. (수동으로 또는 도구를 통해) 위 단계를 완료한 경우 '코드를 컨트리뷰트하기 전에'로 이동하세요.
이 장의 나머지 부분에서는 이러한 지침에 대해 자세히 설명합니다. (수동으로 또는 도구를 통해) 위 단계를 완료한 경우 '코드를 기여하기 전에'로 이동하세요.


===0단계: Google 계정 선택===
===0단계: Google 계정 선택===
Go에 대한 기여는 특정 이메일 주소를 가진 Google 계정을 통해 이루어진다. 프로세스 전체와 이후의 모든 기여에 대해 동일한 계정을 사용해야 한다. 개인 주소를 사용할지 회사 주소를 사용할지 결정해야 할 수도 있다. 선택은 기여자가 작성하고 제출할 코드에 대한 저작권을 누가 소유하는지에 따라 달라진다. 사용할 계정을 결정하기 전에 이 주제를 고용주와 논의할 수 있다.
Go에 대한 기여는 특정 이메일 주소를 가진 Google 계정을 통해 이루어집니다. 프로세스 전체와 이후의 모든 기여에 대해 동일한 계정을 사용해야 합니다. 개인 주소를 사용할지 회사 주소를 사용할지 결정해야 할 수도 있습니다. 선택은 기여자가 작성하고 제출할 코드에 대한 저작권을 누가 소유하는지에 따라 달라집니다. 사용할 계정을 결정하기 전에 이 주제를 고용주와 논의할 수 있습니다.


Google 계정은 Gmail 이메일 계정, G Suite 조직 계정 또는 외부 이메일 주소와 연결된 계정일 수 있다. 예를 들어 G Suite를 통해 관리되지 않는 기존 회사 이메일을 사용해야 하는 경우 [https://accounts.google.com/SignUpWithoutGmail 기존 이메일 주소]와 연결된 계정을 만들 수 있다 .
Google 계정은 Gmail 이메일 계정, G Suite 조직 계정 또는 외부 이메일 주소와 연결된 계정일 수 있습니다. 예를 들어 G Suite를 통해 관리되지 않는 기존 회사 이메일을 사용해야 하는 경우 [https://accounts.google.com/SignUpWithoutGmail 기존 이메일 주소]와 연결된 계정을 만들 수 있습니다.


또한 선택한 이메일 주소를 사용하여 커밋을 생성하도록 Git 도구가 구성되어 있는지 확인해야 한다. Git을 전역적으로(모든 프로젝트의 기본값으로) 설정하거나 로컬로(단일 특정 프로젝트의 경우) 설정할 수 있다. 다음 명령어를 사용하여 현재 설정을 확인할 수 있다.
또한 선택한 이메일 주소를 사용하여 커밋을 생성하도록 Git 도구가 구성되어 있는지 확인해야 합니다. Git을 전역적으로(모든 프로젝트의 기본값으로) 설정하거나 로컬로(단일 특정 프로젝트의 경우) 설정할 수 있습니다. 다음 명령어를 사용하여 현재 설정을 확인할 수 있습니다.


<syntaxhighlight lang='console'>
<syntaxhighlight lang='console'>
52번째 줄: 52번째 줄:
===3단계: Gerrit 계정 만들기===
===3단계: Gerrit 계정 만들기===
===4단계: git-codereview 명령어 설치===
===4단계: git-codereview 명령어 설치===
==코드를 컨트리뷰트하기 전에==
==코드를 기여하기 전에==
===컨트리뷰터하는 곳===
===기여하는 곳===
===이슈 트래커 확인===
===이슈 트래커 확인===
===새로운 문제가 있으면 이슈 열기===
===새로운 문제가 있으면 이슈 열기===

2024년 1월 30일 (화) 09:52 판

1 개요

기여 가이드

Go 프로젝트는 모든 기여자를 환영합니다.

본 문서는 Go 프로젝트에 기여하는 과정을 안내하는 가이드로, 다른 오픈소스 프로젝트에서 사용하는 방식과 조금 다릅니다. Git과 Go에 대한 기본적인 이해가 있다고 가정합니다.

여기에 있는 정보 외에도 Go 커뮤니티는 CodeReview 위키 페이지를 유지관리합니다. 리뷰 프로세스를 배우면서 자유롭게 위키에 기여해 보세요.

gccgo 프론트엔드는 다른 곳에 있습니다 gccgo에 기여하기를 참조하세요.

2 기여자 되기

2.1 개요

첫 번째 단계는 Go 기여자로 등록하고 환경을 구성하는 것입니다. 필수 단계의 체크리스트는 다음과 같습니다.

  • 0단계: Go에 기여하는 데 사용할 단일 Google 계정을 결정합니다. 다음 모든 단계에 해당 계정을 사용하고 git 해당 계정의 이메일 주소로 커밋을 생성하도록 구성되어 있는지 확인하세요.
  • 1단계: CLA(기여자 라이선스 계약)에 서명하고 제출합니다 .
  • 2단계: Go Git 저장소에 대한 인증 자격증명을 구성합니다. go.googlesource.com을 방문하여 페이지 오른쪽 상단 메뉴 표시줄에서 '비밀번호 생성'을 클릭하고 지침을 따르세요.
  • 3단계: 이 페이지를 방문하여 Go 팀에서 사용하는 코드 리뷰 도구인 Gerrit에 등록하세요. CLA 및 등록은 귀하의 계정에 대해 한 번만 수행하면 됩니다.
  • 4단계: go install golang.org/x/review/git-codereview@latest를 실행하여 git-codereview를 설치합니다.

이러한 단계를 수행해주는 자동화 도구가 있어서, 다음과 같이 실행해도 됩니다.

$ go install golang.org/x/tools/cmd/go-contrib-init@latest
$ cd /code/to/edit
$ go-contrib-init

이 장의 나머지 부분에서는 이러한 지침에 대해 자세히 설명합니다. (수동으로 또는 도구를 통해) 위 단계를 완료한 경우 '코드를 기여하기 전에'로 이동하세요.

2.2 0단계: Google 계정 선택

Go에 대한 기여는 특정 이메일 주소를 가진 Google 계정을 통해 이루어집니다. 프로세스 전체와 이후의 모든 기여에 대해 동일한 계정을 사용해야 합니다. 개인 주소를 사용할지 회사 주소를 사용할지 결정해야 할 수도 있습니다. 선택은 기여자가 작성하고 제출할 코드에 대한 저작권을 누가 소유하는지에 따라 달라집니다. 사용할 계정을 결정하기 전에 이 주제를 고용주와 논의할 수 있습니다.

Google 계정은 Gmail 이메일 계정, G Suite 조직 계정 또는 외부 이메일 주소와 연결된 계정일 수 있습니다. 예를 들어 G Suite를 통해 관리되지 않는 기존 회사 이메일을 사용해야 하는 경우 기존 이메일 주소와 연결된 계정을 만들 수 있습니다.

또한 선택한 이메일 주소를 사용하여 커밋을 생성하도록 Git 도구가 구성되어 있는지 확인해야 합니다. Git을 전역적으로(모든 프로젝트의 기본값으로) 설정하거나 로컬로(단일 특정 프로젝트의 경우) 설정할 수 있습니다. 다음 명령어를 사용하여 현재 설정을 확인할 수 있습니다.

$ git config --global user.email # 현재 전역 설정 확인
$ git config user.email # 현재 로컬 설정 확인

설정된 주소를 변경하려면:

$ git config --global user.email name@example.com # 전역 설정 변경
$ git config user.email name@example.com # 로컬 설정 변경

2.3 1단계: 기여자 라이선스 계약

2.4 2단계: Git 인증 구성

2.5 3단계: Gerrit 계정 만들기

2.6 4단계: git-codereview 명령어 설치

3 코드를 기여하기 전에

3.1 기여하는 곳

3.2 이슈 트래커 확인

3.3 새로운 문제가 있으면 이슈 열기

4 GitHub을 통해 변경사항 보내기

5 Gerrit을 통해 변경사항 보내기

5.1 개요

5.2 1단계: 소스코드 복제

5.3 2단계: 새 브랜치에서 변경사항 준비

5.4 3단계: 변경사항 테스트

5.5 4단계: 리뷰를 위해 변경사항 보내기

5.6 5단계: 리뷰 후 변경사항 수정

6 좋은 커밋 메시지

6.1 첫 줄

6.2 본문

6.3 이슈 참조

7 리뷰 프로세스

7.1 초보자가 흔히 하는 실수

7.2 트라이봇

7.3 리뷰

7.4 투표 규칙

8 승인된 변경사항 제출=

8.1 추가 정보

9 기타 주제

9.1 저작권 헤더

9.2 메일 오류 트러블슈팅

9.3 변경사항을 빠르게 테스트하기

9.4 리뷰어 지정 / 다른 사람을 CC 지정

9.5 클라이언트 동기화

9.6 다른 사람의 코드 검토

9.7 git aliases 설정

9.8 여러 종속 변경사항 보내기

10 참고

문서 댓글 ({{ doc_comments.length }})
{{ comment.name }} {{ comment.created | snstime }}