사용자 대상 기능을 추가, 변경 또는 삭제하거나 Bazel의 아키텍처를 크게 변경할 계획이라면 변경사항을 제출하기 전에 디자인 문서를 작성하고 검토를 받아야 합니다.
다음은 중요한 변경사항의 몇 가지 예입니다.
- 네이티브 빌드 규칙 추가 또는 삭제
- 네이티브 규칙의 브레이킹 체인지
- 둘 이상의 규칙의 동작에 영향을 미치는 네이티브 빌드 규칙 시맨틱스의 변경사항
- Bazel의 규칙 정의 API 변경사항
- Bazel이 다른 시스템에 연결하는 데 사용하는 API 변경사항
- Starlark 언어, 시맨틱 또는 API 변경사항
- Bazel 성능 또는 메모리 사용량에 광범위한 영향을 미칠 수 있는 변경사항 (개선 또는 나쁨)
- 널리 사용되는 내부 API 변경사항
- 플래그 및 명령줄 인터페이스 변경
디자인 검토 이유
설계 문서를 작성할 때 다른 Bazel 개발자와 협력하여 Bazel 핵심팀의 안내를 받을 수 있습니다. 예를 들어 제안서가 BUILD, WORKSPACE 또는 bzl 파일에서 사용할 수 있는 함수나 객체를 추가, 삭제 또는 수정하는 경우 Starlark팀을 검토자로 추가합니다. 설계 문서는 제출 전에 다음과 같은 이유로 검토됩니다.
- Bazel은 매우 복잡한 시스템입니다. 겉보기에 무해하게 보이는 로컬 변경은 전 세계적으로 상당한 영향을 미칠 수 있습니다.
- 팀은 사용자로부터 많은 기능 요청을 받습니다. 이러한 요청은 기술적 실행 가능성뿐만 아니라 다른 기능 요청과 관련한 중요성까지 평가해야 합니다.
- Bazel 기능은 핵심 팀 외부의 사람들이 구현하는 경우가 많습니다. 이러한 기여자는 매우 다양한 수준의 Bazel 전문성을 가지고 있습니다.
- Bazel팀 자체의 전문성 수준은 다양합니다. 따라서 Bazel의 모든 부분에 대해 온전히 이해할 수 있는 팀원이 없습니다.
- Bazel의 변경사항은 이전 버전과의 호환성을 고려해야 하며 브레이킹 체인지를 방지해야 합니다.
Bazel의 디자인 검토 정책은 다음과 같은 가능성을 극대화하는 데 도움이 됩니다.
- 모든 기능 요청은 기준 수준의 조사를 거칩니다.
- 제대로 작동하지 않을 수도 있는 구현에 투자하기 전에 적절한 사람들이 설계에 대해 평가할 것입니다.
시작하는 데 도움이 되도록 Bazel 제안서 저장소의 설계 문서를 살펴보세요. 설계는 진행 중이므로 구현 세부정보는 시간이 지남에 따라 의견을 통해 변경될 수 있습니다. 게시된 설계 문서는 초기 설계를 담고 있으며 디자인이 구현되는 과정에서 진행 중인 변경사항이 아닙니다. 현재 Bazel 기능에 대한 설명은 항상 문서를 참조하세요.
참여자 워크플로
참여자는 설계 문서를 작성하고, pull 요청을 보내고, 제안서 검토자를 요청할 수 있습니다.
디자인 문서 작성
모든 디자인 문서에는 다음을 포함하는 헤더가 있어야 합니다.
- 저자
- 마지막 주요 변경 날짜
- 리드 검토자 한 명만 포함된 검토자 목록
- 현재 상태 (초안, 검토 중, 승인됨, 거부됨, 구현 중, 구현 중)
- 토론 대화목록 링크 (공지 후 추가 예정)
문서는 누구나 읽을 수 있는 Google 문서로 작성하거나 마크다운을 사용하여 작성할 수 있습니다. 마크다운 / Google Docs 비교에 관해서는 아래에서 읽어보세요.
사용자에게 표시되는 영향이 있는 제안서에는 이전 버전과의 호환성에 미치는 영향을 문서화하는 섹션과 필요한 경우 출시 계획이 있어야 합니다.
pull 요청 만들기
pull 요청 (PR)을 만들어 디자인 문서를 공유하여 문서를 설계 색인에 추가합니다. 마크다운 파일 또는 문서 링크를 PR에 추가합니다.
가능한 경우 리드 검토자를 선택하고 다른 검토자를 참조에 포함합니다. 리드 검토자를 선택하지 않으면 Bazel 유지보수 담당자가 PR에 검토자를 할당합니다.
PR을 만든 후 검토자는 코드 검토 중에 예비 의견을 남길 수 있습니다. 예를 들어 리드 검토자는 추가 검토자를 제안하거나 누락된 정보를 지적할 수 있습니다. 리드 검토자는 검토 프로세스가 시작될 수 있다고 생각되면 PR을 승인합니다. 그렇다고 해서 제안서가 완벽하거나 승인되는 것은 아니며, 토론을 시작하기에 충분한 정보가 제안서에 포함되어 있음을 의미합니다.
새 제안서 발표
PR이 제출되면 bazel-dev에 공지를 보냅니다.
다른 그룹 (예: bazel-discuss)을 복사하여 Bazel 최종 사용자의 의견을 받을 수 있습니다.
검토자와 반복
관심 있는 모든 사용자가 제안에 댓글을 달 수 있습니다. 질문에 답하고, 제안을 명확히 하고, 우려사항을 해결해 보세요
토론은 공지 대화목록에서 이루어져야 합니다. 제안서가 Google 문서에 있는 경우 댓글을 대신 사용할 수 있습니다 (익명 댓글은 허용됨).
상태 업데이트
반복이 완료되면 새 PR을 만들어 제안서 상태를 업데이트합니다. 동일한 리드 검토자에게 PR을 전송하고 다른 검토자를 참조에 포함합니다.
제안서를 공식적으로 수락하기 위해 리드 검토자는 다른 검토자가 결정에 동의했는지 확인한 후 PR을 승인합니다.
첫 번째 공지 후 제안서 승인 시점 사이에 최소 1주일의 간격이 있어야 합니다. 이렇게 하면 사용자가 충분한 시간을 가지고 문서를 읽고 우려사항을 공유할 수 있습니다.
제안이 수락되기 전에 개념 증명 또는 실험 등으로 구현을 시작할 수 있습니다. 그러나 검토가 완료되기 전에는 변경사항을 제출할 수 없습니다.
리드 검토자 선택
리드 검토자는 다음과 같은 도메인 전문가여야 합니다.
- 관련 하위 시스템에 대한 지식이 있음
- 객관적이고 건설적인 피드백을 제공할 수 있는 능력
- 전체 검토 기간 동안 프로세스를 주도할 수 있습니다.
여러 팀 라벨이 있는지 연락처를 확인해 보세요.
마크다운과 Google Docs 비교
둘 다 허용되므로 가장 적합한 방법을 결정하세요.
Google Docs의 이점:
- 시작하기가 쉬우므로 브레인스토밍에 효과적입니다.
- 공동 편집
- 빠른 반복.
- 수정을 제안할 수 있는 간편한 방법입니다.
마크다운 파일 사용의 이점:
- 연결할 수 있는 정리된 URL을 만듭니다.
- 버전에 대한 명시적 기록입니다.
- 링크를 공개하기 전에 액세스 권한을 설정하는 것을 잊지 마세요.
- 검색엔진으로 쉽게 검색할 수 있습니다.
- 미래 경쟁력: 일반 텍스트는 특정 도구에서 사용할 수 없으며 인터넷 연결이 필요하지 않습니다.
- 작성자가 더 이상 존재하지 않더라도 업데이트할 수 있습니다.
- 비활성 링크 업데이트/감지, 작성자 목록 가져오기 등 자동으로 처리할 수 있습니다.
먼저 Google 문서에서 반복한 다음 나중에 사용할 수 있도록 마크다운으로 변환할 수 있습니다.
Google Docs 사용하기
일관성을 위해 Bazel 디자인 문서 템플릿을 사용합니다. 필요한 헤더를 포함하며 다른 Bazel 관련 문서와의 시각적 일관성을 만듭니다. 이렇게 하려면 File > Make a copy를 클릭하거나 이 링크를 클릭하여 디자인 문서 템플릿의 사본을 만듭니다.
누구나 문서를 읽을 수 있도록 하려면 공유 > 고급 > 변경...을 클릭하고 '사용 - 링크가 있는 모든 사용자'를 선택합니다. 문서에 댓글을 허용하면 Google 계정이 없어도 누구나 익명으로 댓글을 작성할 수 있습니다.
마크다운 사용
문서는 GitHub에 저장되며 GitHub 버전의 마크다운(사양)을 사용합니다.
PR을 만들어 기존 문서를 업데이트합니다. 중대한 변경사항은 문서 검토자가 검토해야 합니다. 사소한 변경사항 (예: 오타, 서식)은 누구나 승인할 수 있습니다.
검토자 워크플로
검토자가 설계 문서를 코멘트하고 검토하고 승인합니다.
일반적인 검토자의 책임
개발자는 디자인 문서를 검토하고, 필요한 경우 추가 정보를 요청하며, 검토 프로세스를 통과한 디자인을 승인할 책임이 있습니다.
새 제안서를 받는 경우
- 문서를 빠르게 살펴보세요.
- 중요한 정보가 누락되었거나 설계가 프로젝트의 목표에 맞지 않는 경우 언급합니다.
- 추가 검토자를 추천합니다.
- 검토 준비가 완료되면 PR을 승인합니다.
검토 프로세스 중
- 문제가 있거나 설명이 필요한 문제에 관해 디자인 작성자와 대화를 나눕니다.
- 해당하는 경우 디자인을 알아야 하는 리뷰 작성자가 아닌 사람의 의견을 초대합니다.
- 승인 전제 조건으로 작성자가 처리해야 하는 댓글을 결정합니다.
- 제안서의 현재 상태가 만족스러우면 토론 대화목록에 'LGTM' (Looks Good To Me)이라고 작성합니다.
모든 디자인 검토 요청에 대해 이 절차를 따르세요. Bazel에 영향을 주는 디자인이 디자인 색인에 없으면 해당 디자인을 승인하지 마세요.
리드 검토자의 책임
개발자는 대기 중인 설계의 구현에 대해 실행 여부를 결정할 책임이 있습니다. 이 작업을 수행할 수 없는 경우 적합한 대리자를 식별하거나 (대리인에게 PR을 재할당하거나) 버그를 Bazel 관리자에게 재할당하여 추가 처리를 해야 합니다.
검토 프로세스 중
- 주석 및 디자인 반복 프로세스가 건설적으로 진행되도록 합니다.
- 승인하기 전에 다른 검토자의 우려가 해결되었는지 확인합니다.
모든 검토자의 승인 후
- 메일링 리스트에 공지한 후 1주일 이상 지났는지 확인합니다.
- PR에서 상태를 업데이트했는지 확인합니다.
- 제안서 작성자가 보낸 PR을 승인합니다.
디자인 거부 중
- PR 작성자가 PR을 전송하거나 PR을 보내야 합니다.
- PR이 문서의 상태를 업데이트합니다.
- 현재 상태에서 디자인을 승인할 수 없는 이유를 설명하고 다음 단계 (예: '잘못된 가정을 다시 제출')를 간략히 설명하는 주석을 문서에 추가합니다.