Berkontribusi ke dokumentasi Bazel

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

Jenis dokumentasi

Situs ini memuat beberapa jenis konten.

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

Infrastruktur dokumentasi

Dokumentasi Bazel ditampilkan dari Google dan file sumber dicerminkan di repositori GitHub Bazel. Anda dapat membuat perubahan pada file sumber di GitHub. Jika disetujui, Anda dapat menggabungkan perubahan dan pengelola Bazel akan mengupdate sumber situs untuk memublikasikan update Anda.

Perubahan kecil

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

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

Perubahan besar

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