Berkontribusi ke dokumentasi Bazel

Laporkan masalah Lihat sumber Per malam · 7,2 · 7,1 · 7,0 · 6,5 · 6,4

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 insinyur/teknik. 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 Anda perlu untuk mengubah sumbernya.

Infrastruktur dokumentasi

Dokumentasi Bazel disajikan dari Google dan file sumber dicerminkan 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 bisa melakukan perubahan kecil, seperti memperbaiki kesalahan atau salah ketik, dalam 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, perubahan yang disarankan, dan Bazel pemilik dokumentasi 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 dan hubungi Pemilik Bazel untuk berkolaborasi.