[Pinot] 오픈소스 기여 프로세스

1. 들어가기 전, 

1.1 개발 환경 설정

[Pinot] Apache Pinot 개발 환경

1.2 모듈 및 아키텍쳐 

pinot-common	프로젝트 전반의 공통 클래스들을 제공 (config, metrics, metadata, pql.parsers, request, response, fs, ...)
pinot-trasnport	Broker의 분산-수집을 처리하는 클래스, Server와 Broker의 연결을 처리하는 nettty의 wrapper 클래스 등
pinot-core	세그먼트 처리, 인덱스, 쿼리 등 데이터와 관련된 Pinot의 핵심 기능을 제공

위 모듈들이 주로 기반이 되며, 그 위에 다양한 모듈들이 쌓이게 된다.

• pinot-server, pinot-controller, pinot-broker
• pinot-minion, pinot-hadoop

 

2. Pinot 기여하기

2.1 작업 흐름

2.1.1. Github 이슈 만들기 

다음과 같은 내용이 포함되어야 하며,  'PEP-Request' 라벨(Pinot Enhancement Proposal)을 붙여야 한다. 

• 무엇을 해야하는가?
• 기능이 필요한 이유는 무엇인가?
• 초기 아이디어 및 제안이 있는가?

PMC(Project Management Committee)는 이 제안을 보고 설계문서가 필요할지, 단순 PR로 해결 가능할지를 결정하며, 리뷰 까지 5일 정도의 시간이 걸릴 수 있다. PMC로 부터 -1 표 없이, 하나 이상의 +1 표를 받는다면 Github Issue에 대한 링크와 함께 PR을 제출할 수 있다. 

GitHub - apache/pinot: Apache Pinot - A realtime distributed OLAP datastore

 

2.1.2. 이슈 브랜치 만들기

cd pinot
#
# ensure you are starting from the latest code base
# the following steps, ensure your fork's (origin's) master is up-to-date
#
git fetch upstream
git checkout master
git merge upstream/master
# create a branch for your issue
git checkout -b <your issue branch>

 

2.1.3. 코드 수정하기 

• 코드 문서화 : public 메소드와 매개변수에 대해, Class 레벨의 Java docs를 포함해야 한다.
• 로깅 : slf4j 로거를 사용한다.
• 호환성 : Zookeeper 또는 세그먼트에 저장된 상태와 관련된 변경은 버전의 호환성 문제가 중요하다.
  (ex. 버전을 업데이트 하는 경우, Server와 Broker가 버전이 다른 경우 등)
• 외부 라이브러리
  • 현재 프로젝트에 포함된 라이브러리 중 기능을 대체할 수 있는 것이 있는가?
  • 해당 라이브러리는 지속 업데이트가 되고 있는가?
  • 라이선스의 문제는 없는가?
• 테스트
  • 단위 테스트 : positive, negative case 모두 포함해야 하며, 테스트에 대한 설명이 포함되어야 한다.
  • IT 테스트 : Mockito로 모킹을 수행하며, REST API의 각 에러 코드에 대한 IT 테스트는 필수로 포함되어야 한다.

 

2.1.4.  PR

# 0. 라이선스 헤더를 붙여준다.
mvn license:format

# 1. 스타일을 점검한다.
mvn checkstyle:check

# 2. 빌드하며, 테스트를 돌려본다. 
mvn clean install -Pbin-dist

# 3. Push 한다. 
git add <files required for the change>
git commit -m "Meaningful oneliner for the change"
git push origin <your issue branch>

# After this, create a PullRequest in `github <https://github.com/apache/pinot/pulls>`_. Include the following information in the description:
#   * The changes that are included in the PR.
#   * Design document, if any.
#   * Information on any implementation choices that were made.
#   * Evidence of sufficient testing. You ``MUST`` indicate the tests done, either manually or automated.
#
# Once the PR is created, the code base is compiled and all tests are run via ``travis``. Make sure you followup on any issues flagged by travis and address them.
# If you see test failures that are intermittent, ``please`` create an issue to track them.
#
# Once the ``travis`` run is clear, request reviews from atleast 2 committers on the project and be sure to gently to followup on the issue with the reviewers.

# 4. PR 후 코멘트나 변경사항이 존재할 때는 반영해준다. 
# commit your changes
git add <updated files>
git commit -m "Meaningful message for the udpate"
# pull new changes
git checkout master
git merge upstream/master
git checkout <your issue branch>
git rebase master

# At this time, if rebase flags any conflicts, resolve the conflicts and follow the instructions provided by the rebase command.
# Run additional tests/validations for the new changes and update the PR by pushing your changes:

git push origin <your issue branch>

 

2.1.5. 문서 반영

Update Documentation - Apache Pinot Docs

 

슬랙 채널에 참여할 수도 있다. 

Community Inviter - Auto Invitation for Slack