이 문서는 Bazel 참여자를 대상으로 합니다.
Bazel의 커밋 설명에는 RELNOTES: 태그와 출시 노트가 포함됩니다. 이는 Bazel팀에서 각 출시의 변경사항을 추적하고 출시 공지사항을 작성하는 데 사용됩니다.
개요
변경사항이 버그 수정인가요? 이 경우 출시 노트가 필요하지 않습니다. GitHub 문제에 대한 참조를 포함하세요.
변경사항이 사용자에게 표시되는 방식으로 Bazel을 추가 / 삭제 / 변경하는 경우 이를 언급하는 것이 유리할 수 있습니다.
중대한 변경이라면 먼저 디자인 문서 정책을 따르세요.
가이드라인
출시 노트는 사용자가 읽어야 하므로 짧고 (한 문장으로 권장), 전문용어 (Bazel 내부 용어)를 피하고 변경사항의 내용에 초점을 맞춰야 합니다.
관련 문서 링크를 포함하세요. 거의 모든 출시 노트에 링크가 포함됩니다. 설명에 플래그, 기능, 명령어 이름이 언급되면 사용자는 이에 대해 자세히 알고 싶어 할 것입니다.
코드, 기호, 플래그 또는 밑줄이 포함된 단어 주위에 백따옴표를 사용합니다.
버그 설명을 단순히 복사하여 붙여넣지 마세요. 대개 수수께끼처럼 치우쳐 있으며, 우리에게만 의미가 있고 사용자가 머릿속을 긁어내게 합니다. 출시 노트는 변경된 내용과 이유를 사용자가 이해하기 쉬운 언어로 설명하기 위한 것입니다.
항상 현재 시제를 사용하고 'Bazel이 이제 Y를 지원합니다' 또는 'X가 이제 Z를 지원합니다'와 같은 형식을 사용하세요. 출시 노트가 버그 항목처럼 들리지 않기를 바랍니다. 모든 출시 노트 항목은 정보를 제공해야 하며 일관된 스타일과 언어를 사용해야 합니다.
지원 중단되었거나 삭제된 항목이 있는 경우 'X는 지원 중단되었습니다' 또는 'X가 삭제되었습니다.'를 사용합니다. '삭제됨' 또는 '삭제됨'이 아닙니다.
이제 Bazel이 다르게 하는 경우 '$oldBehavior 대신 X 이제 $newBehavior'를 현재형으로 사용합니다. 이를 통해 사용자는 새 출시 버전을 사용할 때 예상되는 사항을 자세히 알 수 있습니다.
현재 Bazel에서 무언가를 지원하거나 더 이상 지원하지 않는 경우 'Bazel에서 이제 X를 지원하거나 더 이상 지원하지 않음'을 사용하세요.
특정 항목이 삭제 / 지원 중단 / 변경된 이유를 설명하세요. 한 문장으로는 충분하지만 사용자가 빌드에 미치는 영향을 평가할 수 있어야 합니다.
향후 기능에 대해 약속하면 안 됩니다. '이 플래그가 삭제됩니다' 또는 '변경될 예정입니다'와 같은 표현을 사용하지 않습니다. 불확실성을 야기합니다. 사용자가 가장 먼저 궁금해 할 것은 '언제?'입니다. 우리는 사용자가 알 수 없는 시간에 현재 빌드가 손상되는 것을 걱정하기를 원하지 않습니다.
처리
출시 프로세스의 일환으로 모든 커밋의 RELNOTES 태그를 수집합니다. Google은 메모를 검토, 수정, 정리하는 Google 문서의 모든 내용을 복사합니다.
출시 관리자가 bazel-dev 메일링 리스트로 이메일을 보냅니다. Bazel 참여자는 문서에 참여하여 변경사항이 공지사항에 올바르게 반영되도록 할 수 있습니다.
나중에 bazel-blog 저장소를 사용하여 Bazel 블로그에 공지사항이 제출됩니다.