Memberi nama project terkait Bazel

Laporkan masalah Lihat sumber

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

Menamai aturan Starlark

Lihat Men-deploy aturan Starlark baru dalam 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 bisa jadi sulit. Jika kita tidak berhati-hati dan menggunakan terlalu banyak nama kode, ekosistem Bazel bisa menjadi sangat sulit untuk dipahami bagi pengguna baru.

Ikuti panduan berikut untuk penamaan alat Bazel:

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

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

  3. Memilih menggunakan nama yang deskriptif tentang fungsi alat: Idealnya, nama tidak perlu memiliki subtitel agar pengguna dapat menebak yang pertama dari alat ini. Menggunakan kata bahasa Inggris yang dipisahkan oleh spasi adalah cara yang baik untuk mencapainya.

  4. Ini bukan persyaratan untuk menggunakan tema bunga atau makanan: Bazel membangkitkan basil, tanaman. Anda tidak perlu mencari nama yang berupa tanaman, makanan, atau yang terkait dengan "basil".

  5. Jika alat Anda terkait dengan merek pihak ketiga lain, gunakan hanya sebagai deskriptor: Misalnya, gunakan "Marator Bazel untuk 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 pisah, 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 mencari. Ini menggunakan merek pihak ketiga sebagai deskripsi.
  • Bazel buildfarm: "buildfarm" adalah peternakan kompilasi. Pengguna akan memahami bahwa project ini berkaitan dengan proses build di server.

Contoh nama yang harus dihindari:

  • Ocimum: Nama ilmiah kemangi tidak cukup berhubungan dengan project 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.