Pertama-tama, terima kasih telah berkontribusi pada ekosistem Bazel. Hubungi komunitas Bazel di daftar milis bazel-discuss untuk membagikan project Anda dan nama yang disarankan.
Jika Anda membuat alat terkait Bazel atau membagikan aturan Skylark, sebaiknya ikuti panduan berikut untuk nama project Anda:
Penamaan aturan Starlark
Lihat Men-deploy aturan Starlark baru dalam dokumentasi.
Penamaan alat terkait Bazel lainnya
Bagian ini berlaku jika Anda membuat alat untuk memperkaya ekosistem Bazel. Misalnya, plugin IDE baru atau migrator sistem build baru.
Memilih nama yang bagus untuk alat Anda bisa jadi sulit. Jika kita tidak berhati-hati dan menggunakan terlalu banyak nama kode, ekosistem Bazel bisa menjadi sangat sulit dipahami oleh pengguna baru.
Ikuti panduan berikut untuk memberi nama alat Bazel:
Lebih memilih tidak memperkenalkan nama merek baru: "Bazel" sudah menjadi merek baru bagi pengguna kami, jadi kami harus menghindari membingungkan mereka dengan terlalu banyak nama baru.
Lebih baik menggunakan nama yang menyertakan "Bazel": Hal ini membantu menunjukkan bahwa alat tersebut terkait dengan Bazel, dan juga membantu orang menemukannya dengan mesin telusur.
Sebaiknya gunakan nama yang mendeskripsikan fungsi alat: Idealnya, nama tidak memerlukan subjudul agar pengguna dapat menebak dengan baik fungsi alat tersebut. Menggunakan kata-kata bahasa Inggris yang dipisahkan oleh spasi adalah cara yang baik untuk melakukannya.
Tidak ada persyaratan untuk menggunakan tema bunga atau makanan: Bazel mengingatkan pada basil, tanaman. Anda tidak perlu mencari nama yang merupakan tanaman, makanan, atau yang terkait dengan "kemangi".
Jika alat Anda terkait dengan merek pihak ketiga lain, gunakan hanya sebagai deskriptor: Misalnya, gunakan "Pemigrasi Bazel untuk Cmake" dan bukan "Pemigrasi Bazel Cmake".
Pedoman ini juga berlaku untuk URL repositori GitHub. Membaca URL repositori akan membantu orang memahami fungsi alat tersebut. Tentu saja, nama repositori dapat lebih pendek dan harus menggunakan tanda hubung, bukan spasi, dan huruf kecil.
Contoh nama yang baik:
- Bazel for Eclipse: Pengguna akan memahami bahwa jika mereka ingin menggunakan Bazel dengan Eclipse, di sinilah mereka harus mencari. Menggunakan merek pihak ketiga sebagai deskriptor.
- Buildfarm Bazel: "Buildfarm" adalah compile farm. Pengguna akan memahami bahwa project ini terkait dengan pembangunan di server.
Contoh nama yang harus dihindari:
- Ocimum: Nama ilmiah basil tidak cukup terkait dengan project Bazel.
- Bazelizer: Alat di balik nama ini dapat melakukan banyak hal, nama ini tidak cukup deskriptif.
Perhatikan bahwa rekomendasi ini selaras dengan panduan yang digunakan Google saat melakukan open source pada suatu project.