Jika Anda berencana menambahkan, mengubah, atau menghapus fitur yang dapat dilihat pengguna, atau membuat perubahan arsitektur yang signifikan pada Bazel, Anda harus menulis dokumen desain dan meninjaunya sebelum dapat mengirimkan perubahan tersebut.
Berikut beberapa contoh perubahan signifikan:
- Penambahan atau penghapusan aturan build native
- Perubahan yang menyebabkan gangguan pada aturan native
- Perubahan pada semantik aturan build native yang memengaruhi perilaku lebih dari satu aturan
- Perubahan pada API definisi aturan Bazel
- Perubahan pada API yang digunakan Bazel untuk terhubung ke sistem lain
- Perubahan pada bahasa, semantik, atau API Starlark
- Perubahan yang dapat berdampak luas pada performa atau penggunaan memori Bazel (baik atau buruk)
- Perubahan pada API internal yang banyak digunakan
- Perubahan pada flag dan antarmuka command line.
Alasan peninjauan desain
Saat menulis dokumen desain, Anda dapat berkoordinasi dengan developer Bazel lainnya dan meminta panduan dari tim inti Bazel. Misalnya, jika proposal menambahkan, menghapus, atau mengubah fungsi atau objek apa pun yang tersedia di file BUILD, MODULE.bazel, atau file bzl, tambahkan tim Starlark sebagai peninjau. Dokumen desain ditinjau sebelum pengiriman karena:
- Bazel adalah sistem yang sangat kompleks; perubahan lokal yang tampaknya tidak berbahaya dapat memiliki konsekuensi global yang signifikan.
- Tim menerima banyak permintaan fitur dari pengguna; permintaan tersebut perlu dievaluasi tidak hanya untuk kelayakan teknis, tetapi juga kepentingannya terkait permintaan fitur lainnya.
- Fitur Bazel sering kali diimplementasikan oleh orang di luar tim inti; kontributor tersebut memiliki tingkat keahlian Bazel yang sangat bervariasi.
- Tim Bazel sendiri memiliki tingkat keahlian yang bervariasi; tidak ada satu anggota tim pun yang memiliki pemahaman lengkap tentang setiap aspek Bazel.
- Perubahan pada Bazel harus mempertimbangkan kompatibilitas mundur dan menghindari perubahan yang menyebabkan gangguan.
Kebijakan peninjauan desain Bazel membantu memaksimalkan kemungkinan bahwa:
- semua permintaan fitur mendapatkan tingkat pengawasan dasar.
- orang yang tepat akan mempertimbangkan desain sebelum kita berinvestasi dalam implementasi yang mungkin tidak berfungsi.
Untuk membantu Anda memulai, lihat dokumen desain di Repositori Proposal Bazel. Desain adalah pekerjaan yang sedang berlangsung, sehingga detail implementasi dapat berubah dari waktu ke waktu dan dengan masukan. Dokumen desain yang dipublikasikan mencakup desain awal, dan bukan perubahan yang sedang berlangsung saat desain diimplementasikan. Selalu buka dokumentasi untuk mengetahui deskripsi fungsi Bazel saat ini.
Alur Kerja Kontributor
Sebagai kontributor, Anda dapat menulis dokumen desain, mengirim permintaan pull, dan meminta peninjau untuk proposal Anda.
Menulis dokumen desain
Semua dokumen desain harus memiliki header yang mencakup:
- penulis
- tanggal perubahan besar terakhir
- daftar peninjau, termasuk satu (dan hanya satu) peninjau utama
- status saat ini (draf, dalam peninjauan, disetujui, ditolak, sedang diimplementasikan, diimplementasikan)
- link ke rangkaian diskusi (akan ditambahkan setelah pengumuman)
Dokumen dapat ditulis sebagai Dokumen Google yang dapat dibaca oleh siapa saja atau menggunakan Markdown. Baca perbandingan Markdown / Google Dokumen di bawah untuk a .
Proposal yang memiliki dampak yang dapat dilihat pengguna harus memiliki bagian yang mendokumentasikan dampak pada kompatibilitas mundur (dan rencana peluncuran jika diperlukan).
Membuat Permintaan Pull
Bagikan dokumen desain Anda dengan membuat permintaan pull (PR) untuk menambahkan dokumen ke indeks desain. Tambahkan file markdown atau link dokumen ke PR Anda.
Jika memungkinkan, pilih peninjau utama. dan cc peninjau lainnya. Jika Anda tidak memilih peninjau utama, pengelola Bazel akan menetapkannya ke PR Anda.
Setelah Anda membuat PR, peninjau dapat memberikan komentar awal selama peninjauan kode. Misalnya, peninjau utama dapat menyarankan peninjau tambahan, atau menunjukkan informasi yang tidak ada. Peninjau utama menyetujui PR jika mereka yakin proses peninjauan dapat dimulai. Hal ini tidak berarti proposal tersebut sempurna atau akan disetujui; artinya proposal tersebut berisi informasi yang cukup untuk memulai diskusi.
Mengumumkan proposal baru
Kirim pengumuman ke bazel-dev saat PR dikirimkan.
Anda dapat menyalin grup lain (misalnya, bazel-discuss, untuk mendapatkan masukan dari pengguna akhir Bazel).
Melakukan iterasi dengan peninjau
Siapa pun yang tertarik dapat memberikan komentar pada proposal Anda. Coba jawab pertanyaan, jelaskan proposal, dan atasi masalah.
Diskusi harus dilakukan di rangkaian pengumuman. Jika proposal berada di Dokumen Google, komentar dapat digunakan sebagai gantinya (Perhatikan bahwa komentar anonim diizinkan).
Memperbarui status
Buat PR baru untuk memperbarui status proposal, saat iterasi selesai. Kirim PR ke peninjau utama yang sama dan cc peninjau lainnya.
Untuk secara resmi menerima proposal, peninjau utama menyetujui PR setelah memastikan bahwa peninjau lainnya menyetujui keputusan tersebut.
Harus ada jeda minimal 1 minggu antara pengumuman pertama dan persetujuan proposal. Hal ini memastikan pengguna memiliki cukup waktu untuk membaca dokumen dan menyampaikan kekhawatiran mereka.
Implementasi dapat dimulai sebelum proposal diterima, misalnya sebagai bukti konsep atau eksperimen. Namun, Anda tidak dapat mengirimkan perubahan sebelum peninjauan selesai.
Memilih peninjau utama
Peninjau utama harus merupakan pakar domain yang:
- Memiliki pengetahuan tentang subsistem yang relevan
- Objektif dan mampu memberikan masukan yang membangun
- Tersedia selama periode peninjauan untuk memimpin proses
Pertimbangkan untuk memeriksa kontak untuk berbagai label tim.
Markdown vs Google Dokumen
Tentukan mana yang paling sesuai untuk Anda, karena keduanya diterima.
Manfaat menggunakan Google Dokumen:
- Efektif untuk brainstorming, karena mudah digunakan.
- Pengeditan kolaboratif.
- Iterasi cepat.
- Cara mudah untuk menyarankan pengeditan.
Manfaat menggunakan file Markdown:
- URL yang jelas untuk menghubungkan.
- Catatan revisi yang eksplisit.
- Tidak perlu khawatir lupa menyiapkan hak akses sebelum memublikasikan link.
- Mudah ditelusuri dengan mesin telusur.
- Tahan lama: Teks biasa tidak bergantung pada alat tertentu dan tidak memerlukan koneksi Internet.
- Teks biasa dapat diperbarui meskipun penulisnya tidak ada lagi.
- Teks biasa dapat diproses secara otomatis (memperbarui/mendeteksi link yang tidak berfungsi, mengambil daftar penulis, dll.).
Anda dapat memilih untuk melakukan iterasi terlebih dahulu di Dokumen Google, lalu mengonversinya ke Markdown untuk arsip.
Menggunakan Google Dokumen
Untuk konsistensi, gunakan template dokumen desain Bazel. Template ini mencakup header yang diperlukan dan membuat konsistensi visual dengan dokumen terkait Bazel lainnya. Untuk melakukannya, klik File > Buat salinan atau klik link ini untuk membuat salinan dokumen desain template.
Agar dokumen Anda dapat dibaca oleh siapa saja, klik Bagikan > Lanjutan > Ubah…, lalu pilih "Aktif - Siapa saja yang memiliki link". Jika Anda mengizinkan komentar pada dokumen, siapa saja dapat memberikan komentar secara anonim, bahkan tanpa akun Google.
Menggunakan Markdown
Dokumen disimpan di GitHub dan menggunakan format Markdown GitHub (Spesifikasi).
Buat PR untuk memperbarui dokumen yang ada. Perubahan signifikan harus ditinjau oleh peninjau dokumen. Perubahan kecil (seperti kesalahan ketik, pemformatan) dapat disetujui oleh siapa saja.
Alur kerja peninjau
Peninjau memberikan komentar, meninjau, dan menyetujui dokumen desain.
Tanggung jawab peninjau umum
Anda bertanggung jawab untuk meninjau dokumen desain, meminta informasi tambahan jika diperlukan, dan menyetujui desain yang lulus proses peninjauan.
Saat Anda menerima proposal baru
- Lihat sekilas dokumen.
- Berikan komentar jika informasi penting tidak ada, atau jika desain tidak sesuai dengan tujuan project.
- Sarankan peninjau tambahan.
- Setujui PR saat siap ditinjau.
Selama proses peninjauan
- Lakukan dialog dengan penulis desain tentang masalah yang bermasalah atau memerlukan klarifikasi.
- Jika sesuai, undang komentar dari non-peninjau yang harus mengetahui desain.
- Tentukan komentar mana yang harus ditangani oleh penulis sebagai prasyarat persetujuan.
- Tulis "LGTM" (Looks Good To Me) di rangkaian diskusi jika Anda puas dengan status proposal saat ini.
Ikuti proses ini untuk semua permintaan peninjauan desain. Jangan menyetujui desain yang memengaruhi Bazel jika tidak ada dalam indeks desain.
Tanggung jawab peninjau utama
Anda bertanggung jawab untuk membuat keputusan setuju / tidak setuju terkait implementasi desain yang tertunda. Jika Anda tidak dapat melakukannya, Anda harus mengidentifikasi delegasi yang sesuai (tetapkan ulang PR ke delegasi), atau tetapkan ulang bug ke pengelola Bazel untuk disposisi lebih lanjut.
Selama proses peninjauan
- Pastikan proses iterasi komentar dan desain berjalan secara konstruktif.
- Sebelum persetujuan, pastikan kekhawatiran dari peninjau lain telah diselesaikan.
Setelah disetujui oleh semua peninjau
- Pastikan sudah ada jeda minimal 1 minggu sejak pengumuman di milis.
- Pastikan PR memperbarui status.
- Setujui PR yang dikirim oleh penulis proposal.
Menolak desain
- Pastikan penulis PR mengirim PR; atau kirimkan PR kepada mereka.
- PR memperbarui status dokumen.
- Tambahkan komentar ke dokumen yang menjelaskan alasan desain tidak dapat disetujui dalam statusnya saat ini, dan menguraikan langkah berikutnya, jika ada (seperti "tinjau kembali asumsi yang tidak valid dan kirim ulang").