Terima kasih telah berkontribusi pada dokumentasi Bazel. Ada beberapa cara untuk membantu membuat dokumen yang lebih baik bagi komunitas kita.
Jenis dokumentasi
Situs ini mencakup beberapa jenis konten.
- Dokumentasi naratif, yang ditulis oleh penulis teknis dan engineer. Sebagian besar situs ini berisi dokumentasi naratif yang mencakup panduan berbasis tugas dan konseptual.
- Dokumentasi referensi, yang merupakan dokumentasi yang dihasilkan dari komentar kode. Anda tidak dapat langsung mengubah halaman dokumen referensi, tetapi harus mengubah sumbernya.
Infrastruktur dokumentasi
Dokumentasi Bazel disajikan dari Google dan file sumbernya diduplikasi di repositori GitHub Bazel. Anda dapat melakukan perubahan pada file sumber di GitHub. Jika disetujui, Anda dapat menggabungkan perubahan dan pemelihara Bazel akan memperbarui sumber situs untuk memublikasikan pembaruan Anda.
Perubahan kecil
Anda dapat menangani perubahan kecil, seperti memperbaiki kesalahan 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 dengan detail dan perubahan yang disarankan, lalu pemilik dokumentasi Bazel akan melakukan pembaruan.
Perubahan besar
Jika Anda 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.