기여하기

기여하기 (Contributing)

Apache Pinot의 모든 종류의 기여를 환영한다는 내용을 다루는 문서예요. 코드, 문서, 버그 리포트, 디자인 제안이 모두 해당돼요. 이 페이지는 문서의 오타 수정부터 주요 새 기능 구축까지, 누구든 기여하고 싶은 사람들을 위한 단일 시작점이에요.

출처: 문서

본문

Apache Pinot는 코드, 문서, 버그 리포트, 디자인 제안 등 모든 종류의 기여를 환영해요. 이 페이지는 문서의 오타 수정부터 주요 새 기능 구축까지 기여하고 싶은 누구를 위한 단일 시작점이에요.

한눈에 보는 기여 경로 (Contribution paths at a glance)

코드 기여 워크플로우 (요약) (Code contribution workflow (summary))

전체 상세 내용은 기여 지침에 있어요. 높은 수준의 흐름은 다음과 같아요:

1. GitHub 이슈 열기 -- 무엇을 변경할지, 왜 하는지 설명.
2. 동의 얻기 -- 대형 기능의 경우 Pinot 개선 제안(PEP) 디자인 문서를 작성하고 PMC 승인을 받는다.
3. fork에 브랜치 생성 -- 변경을 구현하고 테스트를 추가한다.
4. 로컬에서 검증 실행 -- mvn checkstyle:check와 mvn clean install -Pbin-dist.
5. 풀 리퀘스트 열기 -- 명확한 설명, 이슈 링크, 테스트 증거 포함.
6. 리뷰 피드백에 응답 -- 필요에 따라 master에 리베이스하고 병합을 기다린다.
7. 문서 업데이트 -- 변경이 새 사용자 대상 동작을 도입한다면.

문서 기여 워크플로우 (요약) (Documentation contribution workflow (summary))

전체 상세 내용은 Apache Pinot 문서 기여하기에 있어요.

1. pinot-docs 저장소를 fork하고 clone한다.
2. Markdown으로 로컬에서 편집한다. Pinot 특정 규칙은 스타일 가이드를 따른다.
3. fork에 커밋하고 푸시한다.
4. 업스트림 문서 저장소에 풀 리퀘스트를 연다.
5. 리뷰 피드백을 반영한다 -- 병합 후 변경 사항은 GitBook에 자동 표시된다.

신뢰받는 기여자는 GitBook UI에서 직접 편집할 수도 있어요. 접근을 요청하려면 [email protected]로 연락해요.

사전 요구 사항 (Prerequisites)

• GitHub 계정
• 코드 기여: 동작하는 로컬 빌드 (코드 설정 참고)
• 문서 기여: Markdown과 Git에 대한 이해

다음 단계 (Next step)

도움, 논의, 협업을 위해 Pinot 커뮤니티와 연결해요:

• 커뮤니티 (Community)

더 알아보기 (Learn more)

• 기여 지침 (Contribution Guidelines)
• Apache Pinot 문서 기여하기
• Pinot 문서 스타일 가이드
• 문서 업데이트 (Update Documentation)