Berkontribusi pada dokumentasi Bazel

Laporkan masalah Lihat sumber

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

Jenis dokumentasi

Situs ini menyertakan beberapa jenis konten.

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

Infrastruktur dokumentasi

Dokumentasi Bazel disalurkan dari Google dan file sumber dicerminkan di repositori GitHub Bazel. Anda dapat mengubah file sumber di GitHub. Jika disetujui, Anda dapat menggabungkan perubahan dan pengelola Bazel akan memperbarui sumber situs untuk memublikasikan update 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 melaporkan bug beserta detail dan perubahan yang disarankan, dan pemilik dokumentasi Bazel akan melakukan update.

Perubahan besar

Jika Anda 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.