Aturan yang Direkomendasikan

Dalam dokumentasi, kami memberikan daftar aturan yang direkomendasikan.

Ini adalah sekumpulan aturan berkualitas tinggi, yang akan memberikan pengalaman yang baik bagi pengguna kami. Kami membedakan antara aturan yang didukung dan ratusan aturan yang dapat Anda temukan di Internet.

Nominasi

Jika serangkaian aturan memenuhi persyaratan di bawah, pengelola aturan dapat mencalonkannya untuk menjadi bagian dari aturan yang direkomendasikan dengan mengajukan masalah GitHub.

Setelah ditinjau oleh tim inti Bazel, fitur tersebut akan direkomendasikan di situs Bazel.

Persyaratan untuk pengelola aturan

  • Kumpulan aturan menyediakan fitur penting yang berguna bagi banyak pengguna Bazel (misalnya, dukungan untuk bahasa yang sangat populer).
  • Ruleset dikelola dengan baik. Harus ada minimal dua pemelihara aktif.
  • Set aturan didokumentasikan dengan baik, dengan contoh, dan mudah digunakan.
  • Set aturan mengikuti praktik terbaik dan berperforma baik (lihat panduan performa).
  • Set aturan memiliki cakupan pengujian yang memadai.
  • Rangkaian aturan diuji di BuildKite dengan Bazel versi terbaru. Pengujian harus selalu berhasil (saat digunakan sebagai pemeriksaan sebelum pengiriman).
  • Set aturan juga diuji dengan perubahan yang tidak kompatibel yang akan datang. Kerusakan harus diperbaiki dalam waktu dua minggu. Masalah migrasi harus segera dilaporkan kepada tim Bazel.

Persyaratan untuk developer Bazel

  • Aturan yang direkomendasikan sering diuji dengan Bazel di head (setidaknya sekali sehari).
  • Tidak ada perubahan di Bazel yang dapat melanggar aturan yang direkomendasikan (dengan setelan default flag). Jika hal ini terjadi, perubahan harus diperbaiki atau di-roll back.

Demosi

Jika ada kekhawatiran bahwa serangkaian aturan tertentu tidak lagi memenuhi persyaratan, masalah di GitHub harus dilaporkan.

Pengelola aturan akan dihubungi dan harus merespons dalam waktu 2 minggu. Berdasarkan hasilnya, tim inti Bazel dapat membuat keputusan untuk menurunkan kualitas set aturan.