Bazel のドキュメントへのご協力ありがとうございます。コミュニティ向けのドキュメントを改善する 方法はいくつかあります。
ドキュメントの種類
このサイトには、いくつかの種類のコンテンツが含まれています。
- テクニカル ライターと エンジニアが作成した 解説ドキュメント。このサイトのほとんどは、 コンセプトとタスクベースのガイドをカバーする解説ドキュメントです。
- コードのコメントから生成された リファレンス ドキュメント。 リファレンス ドキュメントのページを直接変更することはできません。代わりに、ソースを変更する 必要があります。
ドキュメント インフラストラクチャ
Bazel のドキュメントは Google から提供され、ソースファイルは Bazel の GitHub リポジトリにミラーリングされます。GitHub でソースファイルを変更できます。 承認されると、変更をマージできます。Bazel のメンテナーが ウェブサイトのソースを更新して、更新を公開します。
小さな変更
エラーや誤字脱字の修正など、小さな変更を行う方法はいくつかあります 。
- pull リクエスト。ウェブベースのエディタまたはブランチを使用して、GitHub で pull リクエストを作成できます。
- バグ。詳細と変更案を記載してバグを報告すると、Bazel ドキュメントのオーナーが更新を行います。
大きな変更
既存のドキュメントに大幅な変更を加える場合や、 新しいドキュメントを提案する場合は、pull リクエストを作成するか、Google ドキュメントから始めて Bazel のオーナーに連絡して共同作業を行います。