撰寫版本資訊

本文件的目標對象為 Bazel 協作者。

Bazel 中的修訂版本說明包含 RELNOTES: 標記,後面接著版本資訊。Bazel 團隊會使用這項資訊追蹤每個版本的變更,並撰寫版本公告。

總覽

  • 您所做的變更是否修正了錯誤?在這種情況下,您不需要提供版本資訊。請附上 GitHub 問題參考資料。

  • 如果變更能以使用者可見的方式新增 / 移除 / 變更 Bazel,提及這類變更或許對您更有利。

如果變更較為重大,請先遵守設計文件政策

規範

使用者將閱讀版本資訊,因此請盡量簡短 (最好使用一個句子),避免使用術語 (Bazel-內部術語),將焦點放在變更的內容。

  • 提供相關說明文件的連結。所有的版本資訊都應含有連結。如果說明中提到標記、功能和指令名稱,使用者可能會想進一步瞭解這項資訊。

  • 在程式碼、符號、標記或任何包含底線的任何字詞前後使用引號。

  • 請勿複製及貼上錯誤說明,這些料理通常非常感情,只為了我們而知情,以免使用者刮傷。版本資訊主要用於解釋異動項目,以及透過使用者可理解的用語說明原因。

  • 請一律使用現狀,且「Bazel 現在支援 Y」或「X 現在支援 Z」。我們不希望版本資訊看起來像錯誤項目。所有版本資訊項目都應提供資訊,並使用一致的風格和語言。

  • 如果項目已淘汰或移除,請使用「X 已淘汰」或「X 已移除」。不得「已移除」或「已移除」。

  • 如果 Bazel 現在有不同的行為,請在此時使用「X 現在是 $newBehavior」,而不是 $oldBehavior。如此一來,使用者就能詳細瞭解使用新版本時會發生什麼情況。

  • 如果 Bazel 現在支援或不再支援某些功能,請使用「Bazel 現在支援/不再支援 X」。

  • 說明內容遭到移除 / 淘汰 / 變更的原因。其中一個句子可以延伸,但我們希望使用者能夠評估對其建構的影響。

  • 請勿對日後的功能做出任何保證。避免「這個旗標會遭到移除」或「這將有所變更」。這會產生不確定性使用者首先會想「何時?」,我們不希望使用者在未知時間擔心目前的版本中斷。

處理

發布程序中,我們會收集每個修訂版本的 RELNOTES 標記。我們會在 Google 文件中複製所有內容,方便您審查、編輯及整理筆記。

版本管理員會傳送電子郵件給 bazel-dev 郵寄清單。Bazel 協作者受邀協助編輯文件,並確保其變更能正確反映在公告中。

日後,公告會透過 bazel-blog 存放區提交至 Bazel 網誌