Berkontribusi ke dokumentasi Bazel

Laporkan masalah Lihat sumber

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

Jenis dokumentasi

Situs ini menyertakan beberapa jenis konten.

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

Infrastruktur dokumentasi

Dokumentasi Bazel disajikan 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, dalam beberapa cara.

  • Permintaan pull. 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 update.

Perubahan besar

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