Bazel ile ilgili bir projeyi adlandırma

Sorun bildir Kaynağı görüntüle Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

Ö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 listesinden Bazel topluluğuna ulaşın.

Bazel ile ilgili bir araç geliştiriyorsanız veya Skylark kurallarınızı paylaşıyorsanız projenizin adıyla ilgili şu yönergeleri uygulamanızı öneririz:

Starlark kurallarını adlandırma

Dokümanlardaki Yeni Starlark kurallarını dağıtma bölümüne bakın.

Bu bölüm, Bazel ekosistemini zenginleştirmek için 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ırırken aşağıdaki yönergeleri uygulayın:

  1. Yeni bir marka adı sunmamayı tercih edin: "Bazel" zaten kullanıcılarımız için yeni bir marka. Çok fazla yeni adla kafa karışıklığına yol açmamalıyız.

  2. "Bazel" kelimesini içeren bir ad kullanmayı tercih edin: Bu, aracın Bazel ile ilgili olduğunu belirtmeye yardımcı olur ve kullanıcıların arama motoruyla bulmasını kolaylaştırır.

  3. Aracın ne yaptığıyla ilgili açıklayıcı adlar kullanmayı tercih edin: İdeal olarak, kullanıcıların aracın ne yaptığına dair ilk tahmini doğru yapabilmesi için adın alt başlığa ihtiyacı olmamalıdır. Bunu yapmak için boşluklarla ayrılmış İngilizce kelimeler kullanabilirsiniz.

  4. Çiçek veya yemek teması kullanmak zorunlu değildir: Bazel, fesleğen bitkisini çağrıştırır. Bitki, yiyecek veya "fesleğen" ile ilgili bir ad aramanıza gerek yoktur.

  5. Aracınız başka bir üçüncü taraf markasıyla ilgiliyse bunu yalnızca açıklama olarak kullanın: Örneğin, "Cmake Bazel migrator" yerine "Cmake için Bazel migrator" 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 işe yaradığını anlamasına yardımcı olmalıdır. Elbette, depo adı daha kısa olabilir ve boşluk yerine kısa çizgi, küçük harf kullanmalıdır.

İyi ad örnekleri:

  • Bazel for Eclipse: Kullanıcılar, Bazel'i Eclipse ile kullanmak istiyorlarsa bu sayfayı ziyaret etmeleri gerektiğini anlayacak. Açıklama olarak üçüncü taraf bir marka kullanılıyorsa
  • Bazel buildfarm: "Buildfarm" bir derleme çiftliğidir. Kullanıcılar bu projenin sunucular üzerinde geliştirme ile ilgili olduğunu anlayacak.

Kaçınılması gereken ad örnekleri:

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

Bu önerilerin, Google'ın bir projeyi açık kaynaklı hale getirirken kullandığı yönergelerle uyumlu olduğunu unutmayın.