協助改善 Bazel 說明文件

感謝您參與 Bazel 說明文件！有一些方法可以為我們的社群 製作更優質的文件

說明文件類型

這個網站含有幾種類型的內容。

  • 敘述性說明文件，由技術文件撰寫專員和工程師撰寫。這個網站大部分的內容都是說明文件 涵蓋概念指南和工作導向指南
  • 參考說明文件，這是從程式碼註解產生的說明文件。您無法直接變更參照文件頁面，但需要變更文件來源。

說明文件基礎架構

Bazel 說明文件是由 Google 提供，而原始碼檔案則會在 Bazel 的 GitHub 存放區中複製。您可以在 GitHub 中變更來源檔案。獲得核准後，您可以合併變更，Bazel 維護人員就會更新網站來源來發布更新。

小幅變更

您可以透過多種方式進行小幅變更，例如修正錯誤或錯字。

  • 提取要求。您可以使用網頁式編輯器或分支版本，在 GitHub 建立提取要求。
  • 錯誤。您可以回報錯誤，並附上詳細資料和建議變更，Bazel 說明文件擁有者會進行更新。

大型變更

如要大幅變更現有說明文件或建議新文件，您可以建立提取要求，或是先建立一份 Google 文件，然後聯絡 Bazel 擁有者以協同合作。