Memberi nama project terkait Bazel

Laporkan masalah Lihat sumber {/18/}{/1/}

Pertama, terima kasih telah berkontribusi pada ekosistem Bazel. Hubungi komunitas Bazel di 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:

Menamai aturan Starlark

Lihat Men-deploy aturan Starlark baru di dokumen ini.

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 menggunakan terlalu banyak namakode, ekosistem Bazel bisa menjadi sangat sulit dipahami oleh pengguna baru.

Ikuti pedoman berikut untuk menamai alat Bazel:

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

  2. Lebih memilih menggunakan nama yang menyertakan "Bazel": Hal ini membantu menunjukkan bahwa aplikasi ini adalah alat terkait Bazel. Nama ini juga membantu pengguna menemukannya dengan mesin telusur.

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

  4. Bukan persyaratan untuk menggunakan tema bunga atau makanan: Bazel membangkitkan basil, yakni tanaman. Anda tidak perlu mencari nama yang merupakan tanaman, makanan, atau yang berhubungan dengan "kemangi".

  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 akan membantu orang memahami fungsi alat ini. 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 mencarinya. Contoh ini menggunakan merek pihak ketiga sebagai deskriptor.
  • Bazel buildfarm: "buildfarm" adalah compile farm. Pengguna akan memahami bahwa project ini berkaitan dengan proses build di server.

Contoh nama yang harus dihindari:

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

Perhatikan bahwa rekomendasi ini sesuai dengan panduan yang digunakan Google saat membuat project menjadi open source.