Bazel のドキュメントに貢献する

Bazel のドキュメントにご協力いただきありがとうございます。コミュニティ向けのより良いドキュメントを作成するには、いくつかの方法があります。

ドキュメントの種類

このサイトにはいくつかの種類のコンテンツが含まれています。

• ナラティブ ドキュメント: テクニカル ライターとエンジニアが作成します。このサイトのほとんどは、コンセプト ベースのガイドとタスクベースのガイドを網羅したナラティブ ドキュメントです。
• リファレンス ドキュメント。コードのコメントから生成されたドキュメントです。参照ドキュメントのページを直接変更することはできません。代わりに、ソースを変更する必要があります。

ドキュメント インフラストラクチャ

Bazel のドキュメントは Google から提供され、ソースファイルは Bazel の GitHub リポジトリでミラーリングされます。GitHub でソースファイルを変更できます。承認されると、変更を統合できます。Bazel メンテナーがウェブサイトのソースを更新して、更新内容を公開します。

小規模な変更

エラーや入力ミスを修正するなどの小さな変更には、いくつかの方法で対応できます。

• pull リクエスト。GitHub で pull リクエストを作成するには、ウェブベースのエディタを使用するか、ブランチを使用します。
• バグ。詳細と変更案を記載したバグを報告すると、Bazel ドキュメントのオーナーが更新を行います。

大きな変更

既存のドキュメントに大幅な変更を加える場合や、新しいドキュメントを提案する場合は、pull リクエストを作成するか、Google ドキュメントから始めて Bazel オーナーに連絡して共同作業を行います。