撰寫版本資訊

回報問題 查看來源

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

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

總覽

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

  • 如果變更會以使用者可察覺的方式新增 / 移除 / 變更 Bazel,提及這一點或許會更有利。

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

規範

版本資訊會向使用者顯示,因此標題應簡短 (建議為一句話),避免使用術語 (Bazel-internal 術語) 來突顯變更的內容。

  • 附上相關說明文件的連結。幾乎所有的版本資訊都應包含連結。如果說明提及標記、特徵或指令名稱,使用者可能會想更瞭解相關資訊。

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

  • 不要直接複製並貼上錯誤說明。這些圖片通常深淺不難,對使用者來說也很有意義,不會讓使用者刮傷頭部。版本資訊主要以使用者容易理解的用語說明變更內容,以及原因。

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

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

  • 如果 Bazel 現在以不同方式執行,請在當下使用「X now $newBehavior,而不是 $oldBehavior」。這可讓使用者詳細瞭解使用新版本時可能會遇到的內容。

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

  • 說明項目遭到移除 / 淘汰 / 變更的原因。這只是一個句子,但我們希望使用者能夠評估對建構的影響。

  • 但「請勿」對日後的功能做出任何承諾。請避免使用「這個標記將會移除」或「這會變更」。導致不確定性。使用者首先會想瞭解「何時?」,我們不希望他們開始擔心目前的建構作業在不明時間中斷了。

處理

發布程序中,我們會收集每個修訂版本的 RELNOTES 標記。我們會複製 Google 文件中的所有內容 並加以編輯、編輯和整理

版本管理員會傳送電子郵件給 bazel-dev 郵寄清單。系統會邀請 Bazel 協作者參與文件,並確保變更內容已正確反映在公告中。

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