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

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

ドキュメント タイプ

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

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

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

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

小さな変更

エラーや誤字脱字の修正など、小さな変更を行うには、いくつかの方法があります。

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

大きな変更

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