Pertama, terima kasih telah berkontribusi pada ekosistem Bazel. Hubungi komunitas Bazel di milis bazel-discuss untuk membagikan proyek dan nama yang disarankan.
Jika Anda membangun alat terkait Bazel atau berbagi aturan Skylark, kami sarankan mengikuti panduan ini untuk nama proyek Anda:
Menamai aturan Starlark
Lihat Men-deploy aturan Starlark baru yang ada di dokumen ini.
Menamai alat lain yang terkait dengan Bazel
Bagian ini berlaku jika Anda membangun alat untuk memperkaya ekosistem Bazel. Misalnya, plugin IDE baru atau migrator sistem build baru.
Memilih nama yang tepat untuk alat Anda bukanlah hal yang mudah. Jika kita tidak berhati-hati dan tidak menggunakannya banyak nama kode, ekosistem Bazel bisa menjadi sangat sulit untuk dipahami bagi pengguna baru.
Ikuti pedoman berikut untuk menamai alat Bazel:
Memilih untuk tidak memperkenalkan nama merek baru: "Bazel" sudah menjadi merek baru bagi pengguna, kita harus menghindari kebingungan mereka dengan terlalu banyak nama baru.
Lebih memilih menggunakan nama yang menyertakan "Bazel": Hal ini membantu menyatakan bahwa nama tersebut adalah alat terkait Bazel, yang juga membantu pengguna menemukannya dengan mesin telusur.
Lebih suka menggunakan nama deskriptif tentang apa yang dilakukan alat tersebut: Idealnya, nama tidak memerlukan {i>subtitle<i} agar pengguna memiliki konten pertama yang bagus menebak apa yang dilakukan alat tersebut. Menggunakan kata-kata bahasa Inggris yang dipisahkan dengan spasi adalah hal yang baik tertentu untuk mencapai hal tersebut.
Menggunakan tema bunga atau makanan tidak diwajibkan: Bazel membangkitkan antusiasme basil, yakni tanaman. Anda tidak perlu cari nama yang merupakan tanaman, makanan, atau yang berhubungan dengan "kemangi".
Jika alat Anda berkaitan dengan merek pihak ketiga lainnya, gunakan alat tersebut hanya sebagai deskripsi: Misalnya, gunakan "Bazel migrator for Cmake" bukannya "Migrator Cmake Bazel".
Panduan ini juga berlaku untuk URL repositori GitHub. Membaca repositori URL harus membantu orang memahami fungsi alat tersebut. Tentu saja, repositori nama dapat lebih pendek dan harus menggunakan tanda hubung, bukan spasi dan huruf kecil.
Contoh nama yang baik:
- Bazel untuk Eclipse: Pengguna akan memahami jika mereka ingin menggunakan Bazel dengan Eclipse, di sinilah mereka seharusnya melihat. Menggunakan merek pihak ketiga sebagai deskriptor.
- Bazel buildfarm: "buildfarm" adalah compile pertanian. Pengguna akan memahami bahwa proyek ini berkaitan dengan membangun di server.
Contoh nama yang harus dihindari:
- Ocimum: Nama ilmiah kemangi tidak cukup berhubungan dengan proyek Bazel.
- Bazelizer: Alat di balik nama ini dapat melakukan banyak hal, nama ini tidak cukup deskriptif.
Perhatikan bahwa rekomendasi ini sesuai dengan pedoman Google saat membuat project menjadi open source.