Memberi nama project terkait Bazel

Pertama-tama, terima kasih telah berkontribusi pada ekosistem Bazel. Hubungi komunitas Bazel di milis diskusi bazel untuk membagikan project 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 di dokumen.

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 tidaklah mudah. Jika kami tidak berhati-hati dan menggunakan terlalu banyak namakode, ekosistem Bazel dapat menjadi sangat sulit dipahami bagi pengguna baru.

Ikuti panduan berikut untuk memberi nama alat Bazel:

  1. Memilih tidak memperkenalkan nama merek baru: "Bazel" sudah menjadi merek baru bagi pengguna, kami sebaiknya tidak membingungkan mereka dengan terlalu banyak nama baru.

  2. Lebih suka menggunakan nama yang menyertakan "Bazel": Hal ini membantu menyatakan bahwa nama tersebut adalah alat terkait Bazel, tetapi juga membantu orang menemukannya dengan mesin telusur.

  3. Lebih suka menggunakan nama yang deskriptif tentang fungsi alat tersebut: Idealnya, nama tersebut tidak memerlukan subtitel agar pengguna dapat menebak fungsi alat tersebut. Menggunakan kata-kata bahasa Inggris yang dipisahkan oleh spasi adalah cara yang baik untuk mencapai hal ini.

  4. Penggunaan tema bunga atau makanan tidak diwajibkan: Bazel memunculkan basil, yaitu tanaman. Anda tidak perlu mencari nama yang merupakan tanaman, makanan, atau yang berkaitan dengan "basil".

  5. Jika alat Anda berkaitan dengan merek pihak ketiga lainnya, gunakan hanya sebagai deskriptor: Misalnya, gunakan "Bazel migrator for Cmake", bukan "Cmake Bazel migrator".

Panduan ini juga berlaku untuk URL repositori GitHub. Membaca URL repositori harus 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 baik:

  • Bazel untuk Eclipse: Pengguna akan memahami bahwa jika mereka ingin menggunakan Bazel dengan Eclipse, di sinilah mereka harus mencarinya. Model ini menggunakan merek pihak ketiga sebagai deskriptor.
  • Bazel buildfarm: "buildfarm" adalah farm kompilasi. Pengguna akan memahami bahwa project ini terkait dengan membangun di server.

Contoh nama yang harus dihindari:

  • Ocimum: Nama ilmiah basil tidak cukup berkaitan dengan project Bazel.
  • Bazelizer: Alat di balik nama ini dapat melakukan banyak hal, nama ini tidak cukup deskriptif.

Perlu diperhatikan bahwa rekomendasi ini sesuai dengan panduan yang digunakan Google saat menjadikan project Anda open source.