Memberi nama project terkait Bazel

Laporkan masalah Lihat sumber Nightly · 8.0 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Pertama-tama, terima kasih telah berkontribusi pada ekosistem Bazel. Hubungi komunitas Bazel di mailing list bazel-discuss untuk membagikan project Anda dan nama yang disarankannya.

Jika Anda mem-build 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 dokumen.

Bagian ini berlaku jika Anda mem-build alat untuk memperkaya ekosistem Bazel. Misalnya, plugin IDE baru atau migrasi sistem build baru.

Memilih nama yang bagus untuk alat Anda mungkin sulit. Jika kita tidak berhati-hati dan menggunakan terlalu banyak nama kode, ekosistem Bazel dapat menjadi sangat sulit dipahami bagi pendatang baru.

Ikuti panduan berikut untuk memberi nama alat Bazel:

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

  2. Sebaiknya gunakan nama yang menyertakan "Bazel": Hal ini membantu menunjukkan bahwa alat tersebut terkait dengan Bazel, dan juga membantu orang menemukannya dengan mesin telusur.

  3. Sebaiknya gunakan nama yang deskriptif tentang fungsi alat: Idealnya, nama tidak memerlukan subtitel agar pengguna dapat menebak dengan baik fungsi alat tersebut. Menggunakan kata-kata bahasa Inggris yang dipisahkan oleh spasi adalah cara yang baik untuk melakukannya.

  4. Anda tidak harus menggunakan tema bunga atau makanan: Bazel memunculkan basil, tanaman. Anda tidak perlu mencari nama yang merupakan tanaman, makanan, atau yang terkait dengan "basil".

  5. Jika alat Anda terkait dengan merek pihak ketiga lainnya, gunakan hanya sebagai deskripsi: 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 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, mereka harus mencarinya di sini. Iklan ini menggunakan merek pihak ketiga sebagai deskripsi.
  • Buildfarm Bazel: "Buildfarm" adalah farm kompilasi. Pengguna akan memahami bahwa project ini terkait dengan mem-build 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 project.