Jika Anda berencana untuk menambahkan, mengubah, atau menghapus fitur yang ditampilkan kepada pengguna, atau membuat perubahan arsitektur yang signifikan pada Bazel, Anda harus menulis dokumen desain dan meninjaunya sebelum dapat mengirimkan perubahan.
Berikut beberapa contoh perubahan yang signifikan:
- Penambahan atau penghapusan aturan build native
- Perubahan yang dapat 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 memiliki efek yang 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, saat proposal menambahkan, menghapus, atau mengubah fungsi atau objek apa pun yang tersedia dalam file BUILD, WORKSPACE, atau bzl, tambahkan tim Starlark sebagai peninjau. Dokumen desain ditinjau sebelum dikirimkan karena:
- Bazel adalah sistem yang sangat kompleks; perubahan lokal yang tampaknya tidak berbahaya dapat memiliki konsekuensi global yang signifikan.
- Tim mendapatkan banyak permintaan fitur dari pengguna; permintaan tersebut perlu dievaluasi tidak hanya untuk kelayakan teknis, tetapi juga pentingnya terkait permintaan fitur lainnya.
- Fitur Bazel sering kali diterapkan 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 pun anggota tim yang memiliki pemahaman lengkap tentang setiap sudut Bazel.
- Perubahan pada Bazel harus memperhitungkan kompatibilitas mundur dan menghindari perubahan yang merusak.
Kebijakan peninjauan desain Bazel membantu memaksimalkan kemungkinan bahwa:
- semua permintaan fitur mendapatkan tingkat pemeriksaan dasar.
- orang yang tepat akan mempertimbangkan desain sebelum kita berinvestasi dalam implementasi yang mungkin tidak berhasil.
Untuk membantu Anda memulai, lihat dokumen desain di Repositori Proposal Bazel. Desain masih dalam proses, sehingga detail penerapan dapat berubah dari waktu ke waktu dan dengan masukan. Dokumen desain yang dipublikasikan merekam desain awal, dan bukan perubahan yang sedang berlangsung saat desain diterapkan. 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 menyertakan:
- author
- tanggal perubahan besar terakhir
- daftar peninjau, termasuk satu (dan hanya satu) peninjau utama
- status saat ini (draf, sedang ditinjau, disetujui, ditolak, sedang diterapkan, diterapkan)
- link ke rangkaian pesan diskusi (akan ditambahkan setelah pengumuman)
Dokumen dapat ditulis sebagai Dokumen Google yang dapat dibaca oleh semua orang atau menggunakan Markdown. Baca di bawah untuk mengetahui perbandingan Markdown / Google Dokumen.
Proposal yang memiliki dampak yang terlihat oleh pengguna harus memiliki bagian yang mendokumentasikan dampak pada kompatibilitas mundur (dan rencana peluncuran jika diperlukan).
Membuat Pull Request
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 membuat komentar awal selama peninjauan kode. Misalnya, peninjau utama dapat menyarankan peninjau tambahan, atau menunjukkan informasi yang tidak ada. Peninjau utama menyetujui PR jika mereka percaya bahwa proses peninjauan dapat dimulai. Hal ini tidak berarti proposal tersebut sempurna atau akan disetujui; tetapi berarti proposal tersebut berisi informasi yang memadai untuk memulai diskusi.
Mengumumkan proposal baru
Kirim pengumuman ke bazel-dev saat PR dikirim.
Anda dapat menyalin grup lain (misalnya, bazel-discuss, untuk mendapatkan masukan dari pengguna akhir Bazel).
Melakukan iterasi dengan peninjau
Siapa pun yang tertarik dapat mengomentari proposal Anda. Cobalah untuk menjawab pertanyaan, menjelaskan proposal, dan mengatasi masalah.
Diskusi harus dilakukan di rangkaian pesan pengumuman. Jika proposal ada dalam Google Dokumen, 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 menerima proposal secara resmi, peninjau utama akan menyetujui PR setelah memastikan bahwa peninjau lain setuju dengan keputusan tersebut.
Harus ada setidaknya 1 minggu antara pengumuman pertama dan persetujuan proposal. Hal ini memastikan bahwa pengguna memiliki cukup waktu untuk membaca dokumen dan berbagi kekhawatiran mereka.
Penerapan dapat dimulai sebelum proposal diterima, misalnya sebagai bukti konsep atau eksperimen. Namun, Anda tidak dapat mengirimkan perubahan sebelum peninjauan selesai.
Memilih peninjau prospek
Peninjau utama harus merupakan pakar domain yang:
- Mengetahui subsistem yang relevan
- Objektif dan mampu memberikan masukan yang membangun
- Tersedia selama seluruh 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 bertukar pikiran, karena mudah digunakan.
- Pengeditan kolaboratif.
- Iterasi cepat.
- Cara mudah untuk menyarankan pengeditan.
Manfaat menggunakan file Markdown:
- URL yang bersih untuk penautan.
- Catatan revisi eksplisit.
- Jangan lupa menyiapkan hak akses sebelum memublikasikan link.
- Mudah ditelusuri dengan mesin telusur.
- Masa depan: Teks biasa tidak bergantung pada alat tertentu dan tidak memerlukan koneksi Internet.
- Anda dapat memperbaruinya meskipun penulisnya sudah tidak ada lagi.
- Data tersebut dapat diproses secara otomatis (memperbarui/mendeteksi link mati, mengambil daftar penulis, dll.).
Anda dapat memilih untuk melakukan iterasi terlebih dahulu di Dokumen Google, lalu mengonversinya ke Markdown untuk generasi mendatang.
Menggunakan Google Dokumen
Untuk konsistensi, gunakan template dokumen desain Bazel. File ini menyertakan 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 template dokumen desain.
Agar dokumen Anda dapat dibaca oleh semua orang, 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 ragam Markdown GitHub (Spesifikasi).
Buat PR untuk memperbarui dokumen yang ada. Perubahan yang signifikan harus ditinjau oleh peninjau dokumen. Perubahan sepele (seperti kesalahan ketik, format) 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 dokumen tersebut dengan cepat.
- Berikan komentar jika informasi penting tidak ada, atau jika desain tidak sesuai dengan sasaran project.
- Sarankan peninjau tambahan.
- Setujui PR jika sudah siap ditinjau.
Selama proses peninjauan
- Berdialoglah dengan penulis desain tentang masalah yang bermasalah atau memerlukan klarifikasi.
- Jika sesuai, minta komentar dari non-peninjau yang harus mengetahui desain.
- Tentukan komentar mana yang harus ditangani oleh penulis sebagai prasyarat untuk persetujuan.
- Tulis "LGTM" (Looks Good To Me) di rangkaian pesan 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 go / no-go terkait implementasi desain yang tertunda. Jika tidak dapat melakukannya, Anda harus mengidentifikasi delegasi yang sesuai (menetapkan ulang PR ke delegasi), atau menetapkan ulang bug ke pengelola Bazel untuk disposisi lebih lanjut.
Selama proses peninjauan
- Pastikan proses iterasi komentar dan desain bergerak maju secara konstruktif.
- Sebelum persetujuan, pastikan masalah dari peninjau lain telah diselesaikan.
Setelah disetujui oleh semua peninjau
- Pastikan sudah setidaknya 1 minggu sejak pengumuman di mailing list.
- Pastikan PR memperbarui status.
- Setujui PR yang dikirim oleh penulis proposal.
Menolak desain
- Pastikan penulis PR mengirimkan PR; atau kirimkan PR kepada mereka.
- PR akan 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").