Berkontribusi ke dokumentasi Bazel

Terima kasih telah berkontribusi pada dokumentasi Bazel. Ada beberapa cara untuk membantu membuat dokumen yang lebih baik bagi komunitas kami.

Jenis dokumentasi

Situs ini mencakup beberapa jenis konten.

  • Dokumentasi naratif, yang ditulis oleh penulis teknis dan engineer. Sebagian besar situs ini adalah dokumentasi naratif yang mencakup panduan konseptual dan berbasis tugas.
  • Dokumentasi referensi, yang merupakan dokumentasi yang dihasilkan dari komentar kode. Anda tidak dapat langsung membuat perubahan pada halaman dokumen referensi, tetapi harus mengubah sumbernya.

Infrastruktur dokumentasi

Dokumentasi Bazel ditayangkan dari Google dan file sumbernya diduplikasi di repositori GitHub Bazel. Anda dapat membuat perubahan pada file sumber di GitHub. Jika disetujui, Anda dapat menggabungkan perubahan dan pengelola Bazel akan memperbarui sumber situs untuk memublikasikan pembaruan Anda.

Perubahan kecil

Anda dapat melakukan perubahan kecil, seperti memperbaiki error atau kesalahan ketik, dengan beberapa cara.

  • Permintaan pull. Anda dapat membuat permintaan pull di GitHub dengan editor berbasis web atau di cabang.
  • Bug. Anda dapat mengajukan bug dengan detail dan perubahan yang disarankan, dan pemilik dokumentasi Bazel akan melakukan pembaruan.

Perubahan besar

Jika ingin membuat perubahan besar pada dokumentasi yang ada atau mengusulkan dokumentasi baru, Anda dapat membuat permintaan pull atau memulai dengan Dokumen Google dan menghubungi Pemilik Bazel untuk berkolaborasi.