[Hyperledger Fabric v1.0] 7. CONTRIBUTING(기여): Working with Gerrit(Gerrit으로 작업)

해당 글은 Hyperledger Fabric 페이지의 게시글을 번역 및 정리한 자료입니다.

원본 사이트 : http://hyperledger-fabric.readthedocs.io/en/release/Gerrit/gerrit.html

 Working with Gerrit(Gerrit으로 작업)

다음 지침에 따라 Gerrit 검토 시스템을 통해 Hyperledger Fabric Project에서 공동 작업을 수행하십시오.

메일링리스트에 가입되어 있는지 확인하십시오. 도움이 필요하면 채팅으로 연락하십시오.

Gerrit은 사용자에게 다음 역할을 할당합니다.

• Submitters: 고려 사항 변경 사항을 제출하고 다른 코드 변경 사항을 검토하고 +1 또는 -1로 투표하여 수락 또는 거절 권고를 제출할 수 있습니다.
• Maintainers: +2 또는 -2의 투표자 검토 결과에 따라 변경 사항을 승인하거나 거부 할 수 있습니다.
• Builders: (예 : 젠킨스) 빌드 자동화 인프라를 사용하여 변경 사항을 확인할 수 있습니다.

유지 관리자는 검토 프로세스에 익숙해야합니다. 그러나 누구나 검토 변경을 환영하며 (따라서 권장 할 수 있습니다!) 따라서 가치있는 문서를 찾을 수 있습니다.

Git-review(Git-검토)

Gerrit로 작업 할 때 git-review라는 매우 유용한 도구가 있습니다. 이 명령 줄 도구는 다음 섹션의 대부분을 자동화 할 수 있습니다. 물론 뒤에서 일어나는 일을 이해할 수 있도록 아래 정보를 읽는 것이 좋습니다.

Sandbox project(샌드박스 프로젝트)

개발자가 Gerrit 및 워크 플로우에 익숙해 지도록 샌드 박스 프로젝트를 만들었습니다. 이 프로젝트를 사용하여 아래 명령과 도구를 사용해보십시오.

Getting deeper into Gerrit(Gerrit에 대해 자세히 알아보기)

Gerrit에 대한 포괄적 인 설명은 이 문서의 범위를 벗어납니다. 인터넷에는 많은 리소스가 있습니다. 좋은 요약은 여기에서 찾아 낼 수있다. 또한 유용한 모범 사례를 제공했습니다.

Working with a local clone of the repository(저장소의 로컬 복제 작업)

새로운 기능이든 버그 수정이든 무언가를 작업하려면 다음을 수행하십시오.

1. Gerrit Projects 페이지를 여십시오.
2. 작업하려는 프로젝트를 선택하십시오.
3. Terminal 창을 열고 Clone with git hook URL을 사용하여 프로젝트를 로컬로 복제하십시오. ssh가 선택되어 있으면 인증이 훨씬 간단 해집니다.

   git clone ssh://LFID@gerrit.hyperledger.org:29418/fabric && scp -p -P 29418 LFID@gerrit.hyperledger.org:hooks/commit-msg fabric/.git/hooks/
   

   ※ 패브릭 프로젝트 저장소를 복제하는 경우

   $GOPATH/src/github.com/hyperledger 디렉토리에 복제하여 빌드하고 Vagrant 개발 환경에서 사용할 수 있도록 합니다.
4. 복제 된 저장소에서 설명 적으로 명명 된 분기 만들기

   cd fabric
   git checkout -b issue-nnnn
   

5. 코드를 커밋하십시오. 효과적인 커밋을 만드는 방법에 대한 자세한 내용은 변경 내용 제출시 이 문서를 참조하십시오.

   git commit -s -a
   

   그런 다음 정확하고 읽기 쉬운 커밋 메시지를 입력하고 제출하십시오.
6. 문서에 영향을 미치는 모든 코드 변경 사항에는 문서 및 테스트에 대한 해당 변경 사항 (또는 추가 사항)이 수반되어야합니다. 이렇게하면 병합 된 PR이 되돌려지면 변경 사항의 모든 흔적도 바뀌게됩니다.

Submitting a Change(변경 제출)

현재 Gerrit는 검토를 위해 변경 사항을 제출하는 유일한 방법입니다.

참고 : 변경 사항 제출 및 제출 지침을 검토하십시오.

Use git review(git review 사용)

※ 원할 경우 다음 대신 git-review 도구를 사용할 수 있습니다. 예 :

.git/config에 다음 섹션을 추가하고 <USERNAME>을 gerrit ID로 바꿉니다.

[remote "gerrit"]
    url = ssh://<USERNAME>@gerrit.hyperledger.org:29418/fabric.git
    fetch = +refs/heads/*:refs/remotes/gerrit/*

git review로 변경 사항을 제출하십시오.

$ cd <your code dir>
$ git review

패치를 업데이트 할 때 git commit --amend로 커밋 한 다음 git review명령을 반복하십시오.

Not Use git review(git review 사용 안 함)

소스 코드 작성 지침을 참조하십시오.

변경 내용을 제출할 준비가되면 Gerrit는 변경 내용을 특수 분기로 푸시해야합니다. 이 특수 분기의 이름에는 일단 허용되는 코드가 있어야 할 마지막 분기에 대한 참조가 들어 있습니다.

Hyperledger Fabric Project의 경우 특수 분기는 refs/for/master라고 합니다. 

현재 로컬 개발 브랜치를 gerrit 서버로 푸시하려면 복제 된 리포지토리의 루트에서 터미널 창을 엽니다.

cd <your clone dir>
git push origin HEAD:refs/for/master

명령이 올바르게 실행되면 출력은 다음과 유사하게 나타납니다.

Counting objects: 3, done.
Writing objects: 100% (3/3), 306 bytes | 0 bytes/s, done.
Total 3 (delta 0), reused 0 (delta 0)
remote: Processing changes: new: 1, refs: 1, done
remote:
remote: New Changes:
remote:   https://gerrit.hyperledger.org/r/6 Test commit
remote:
To ssh://LFID@gerrit.hyperledger.org:29418/fabric
* [new branch]      HEAD -> refs/for/master

gerrit 서버는 변경 사항을 추적 할 수있는 링크를 생성합니다.

Adding reviewers(검토자 추가하기)

필요에 따라 변경 사항에 검토자를 추가 할 수 있습니다.

명령 행을 통해 검토 자 목록을 지정하려면 push 명령에 % r=reviewer@project.org를 추가하십시오. 예를 들어,

git push origin HEAD:refs/for/master%r=rev1@email.com,r=rev2@notemail.com

또는 커밋에 동일한 평가자가 모두있는 경우 검토 자 세트를 추가하도록 GIT를 자동 구성 할 수 있습니다.

기본 검토 자 목록을 추가하려면 프로젝트 디렉토리에서 : file : .git/config 파일을 열고 [ branch “master” ]섹션에 다음 줄을 추가하십시오.

[branch "master"] #.... push =
HEAD:refs/for/master%r=rev1@email.com,r=rev2@notemail.com`

@email.com and @notemail.com 주소 대신 실제 이메일 주소를 사용해야합니다. origin을 git 원격 이름으로 바꾸는 것을 잊지 마십시오.

Reviewing Using Gerrit(Gerrit를 사용하여 검토하기)

• Add: 이 버튼을 사용하면 변경 제출자가 변경 사항을 검토해야하는 사람들의 이름을 수동으로 추가 할 수 있습니다. 이름 입력을 시작하면 시스템에 등록 된 사람 목록과 시스템에 대한 액세스 권한에 따라 시스템이 자동 완성됩니다. 그들은 당신이 그들의 입력을 요구하고 있다는 것을 이메일로 통보 받게 될 것입니다.
• Abandon: 이 버튼은 제출자 만 사용할 수 있습니다. 이것은 커미터가 변경 사항을 포기하고 병합 대기열에서 제거 할 수있게합니다.
• Change-ID: 이 ID는 Gerrit (또는 system)에 의해 생성됩니다. 검토 프로세스에서 커밋을 수정해야한다고 결정할 때 유용합니다. 새 버전을 제출할 수 있습니다. 동일한 Change-ID 헤더 (및 값)가있는 경우 Gerrit는이를 기억하고 동일한 변경 사항의 다른 버전으로 제시합니다.
• Status: 현재 왼쪽 상단 모서리의 'Needs Verified (확인 필요)'로 표시된 변경 사례가 리뷰 상태입니다. 검토 자 목록은 모두 의견을 발표하며, 병합에 동의하면 +1을, 동의하지 않으면 -1을 표시합니다. Maintainer 역할을 가진 Gerrit 사용자는 +2 또는 -2의 투표로 병합하거나 거부 할 수 있습니다.

통지는 커밋 메시지의 Signed-by-by 행의 전자 메일 주소로 보내집니다. Gerrit 대시 보드를 방문하여 요청 진행 상황을 확인하십시오.

Gerrit의 기록 탭에는 인라인 코멘트와 리뷰 작성자가 표시됩니다.

Gerrit의 기록 탭에는 인라인 코멘트와 리뷰 작성자가 표시됩니다.

Viewing Pending Changes(대기중인 변경 사항보기)

Find all pending changes by clicking on the link in the upper-left corner, or open this link.

왼쪽 상단 모서리의 All --> Changes 링크를 클릭하여 보류중인 변경 사항을 모두 찾거나이 링크를 여십시오.

여러 프로젝트에서 공동 작업하는 경우 오른쪽 상단의 검색 창을 통해 특정 분기로 검색을 제한 할 수 있습니다.

필터 프로젝트 : fabric을 추가하여 가시적 인 변경 사항을 Hyperledger Fabric Project의 변경 사항으로 제한하십시오.

My --> Changes를 클릭하거나이 링크를 열어 제출 한 모든 현재 변경 사항을 나열하거나 입력이 필요한 변경 사항 만 나열하십시오.