Bazel ile ilgili bir projeyi adlandırma

Sorun bildirme Kaynağı görüntüleme Nightly · 8.0 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Öncelikle Bazel ekosistemine katkıda bulunduğunuz için teşekkür ederiz. Projenizi ve önerilen adını paylaşmak için lütfen bazel-discuss posta listesinde Bazel topluluğuyla iletişime geçin.

Bazel ile ilgili bir araç geliştiriyorsanız veya Skylark kurallarınızı paylaşıyorsanız projenizin adı için aşağıdaki yönergelere uymanızı öneririz:

Starlark kurallarının adlandırılması

Dokümanlar bölümündeki Yeni Starlark kuralları dağıtma başlıklı makaleyi inceleyin.

Bu bölüm, Bazel ekosistemini zenginleştirecek bir araç geliştiriyorsanız geçerlidir. Örneğin, yeni bir IDE eklentisi veya yeni bir derleme sistemi taşıyıcısı.

Aracınız için iyi bir ad seçmek zor olabilir. Dikkatli olmaz ve çok fazla kod adı kullanırsak Bazel ekosisteminin yeni gelenler tarafından anlaşılması çok zor olabilir.

Bazel araçlarını adlandırmayla ilgili aşağıdaki kurallara uyun:

  1. Yeni bir marka adı kullanmamaya çalışın: "Bazel" zaten kullanıcılarımız için yeni bir marka. Kullanıcılarımızı çok fazla yeni adla karıştırmaktan kaçınmalıyız.

  2. "Bazel" içeren bir ad kullanmayı tercih edin: Bu, Bazel ile ilgili bir araç olduğunu ifade etmeye yardımcı olur ve kullanıcıların arama motoru ile bulmasına yardımcı olur.

  3. Aracı açıklayan adlar kullanmayı tercih edin: İdeal olarak, kullanıcıların aracın ne yaptığını ilk bakışta anlayabilmesi için adın altyazıya ihtiyacı olmamalıdır. Bunu yapmak için İngilizce kelimeleri boşluklarla ayırmak iyi bir yöntemdir.

  4. Bitki veya yemek teması kullanmak zorunlu değildir: Bazel, biberiye bitkisini çağrıştırır. Bitki, yiyecek veya "fesleğen"le ilgili bir ad aramanız gerekmez.

  5. Aracınız başka bir üçüncü taraf markasıyla ilgiliyse yalnızca tanımlayıcı olarak kullanın: Örneğin, "Cmake Bazel taşıma aracı" yerine "Cmake için Bazel taşıma aracı" ifadesini kullanın.

Bu yönergeler, GitHub depo URL'si için de geçerlidir. Depo URL'sini okumak, kullanıcıların aracın ne yaptığını anlamalarına yardımcı olur. Elbette, depo adı daha kısa olabilir ve boşluklar ile küçük harfler yerine kısa çizgi kullanılmalıdır.

İyi ad örnekleri:

  • Eclipse için Bazel: Kullanıcılar, Bazel'i Eclipse ile kullanmak istiyorlarsa bu sayfaya bakmaları gerektiğini anlar. Açıklayıcı olarak üçüncü taraf bir marka kullanır.
  • Bazel buildfarm: "buildfarm", derleme çiftliği'dir. Kullanıcılar bu projenin sunucularda geliştirmeyle ilgili olduğunu anlayacaktır.

Kullanılmaması gereken ad örnekleri:

  • Ocimum: Biberiğin bilimsel adı, Bazel projesiyle yeterince alakalı değil.
  • Bazelizer: Bu adın arkasındaki araç birçok şey yapabilir. Bu ad yeterince açıklayıcı değil.

Bu önerilerin, Google'ın bir projeyi açık kaynak olarak yayınlarken kullandığı kurallara uygun olduğunu unutmayın.