Öncelikle, Bazel ekosistemine katkıda bulunduğunuz için teşekkür ederiz. Lütfen şu kişilere ulaşın: Bazel topluluğunun Projenizi ve önerdiğiniz adı paylaşmak için bazel-tartışma posta listesini inceleyin.
Bazel ile ilgili bir araç derliyor veya Skylark kurallarınızı paylaşıyorsanız projenizin adı için şu yönergeleri uygulamanızı öneririz:
Starlark'ı adlandırma kuralları
Yeni Starlark kurallarını dağıtma başlıklı makaleyi inceleyin bazı ipuçları vereceğim.
Bazel ile ilgili diğer araçları adlandırma
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 değilsek çok sayıda kod kullanılırsa Bazel ekosisteminin anlaşılması bir araya getirir.
Bazel araçlarını adlandırırken aşağıdaki yönergeleri uygulayın:
Yeni bir marka adı vermek istemiyorum: "Bazel" zaten yeni bir marka olarak, çok fazla yeni adla kafalarını karıştırmamalıyız.
"Bazel" kelimesini içeren bir ad kullanmayı tercih ediyorum: Bu, her şeyin Bazel ile alakalı bir araçtır, kullanıcıların arama motoruyla bulmasına da yardımcı olur.
Aracın işleviyle ilgili açıklayıcı adlar kullanmayı tercih edin: İdeal olarak, adın bir altyazıya sahip olması için kullanıcının tahminde bulunmanız gerekir. İngilizce kelimeleri boşlukla ayırarak kullanmak yolları aranır.
Çiçek veya yemek teması kullanmak zorunlu değildir: Bazel fesleğen gibi. Herhangi bir teknik bitki veya yiyecek olan ya da "fesleğen" ile alakalı bir ad arayın.
Aracınız başka bir üçüncü taraf markayla ilgiliyse onu yalnızca bir açıklayıcı: Örneğin, "Cmake için Bazel taşıma aracı"nı kullanın yerine "Cmake Bazel taşıyıcı".
Bu yönergeler, GitHub deposu URL'si için de geçerlidir. Depoyu okuma URL, 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 ile küçük harf yerine tire kullanmalıdır.
İyi ad örnekleri:
- Eclipse için Bazel: Kullanıcılar, Bazel kullanmak istediklerinde bu noktaya geliyor. Üçüncü taraf bir marka kullanıyor kullanabilirsiniz.
- Bazel buildfarm: "buildfarm" bir derleme çiftliği. Kullanıcı Sayısı bu projenin sunucular üzerinde derlemeyle ilgili olduğunu anlayacaktır.
Kaçınılması gereken ad örnekleri:
- Ocimum: fesleğnenin bilimsel adı Bazel projesiyle yeterince ilgili değil.
- Bazelizer: Bu adın ardındaki araç pek çok şey yapabilir. yeterince açıklayıcı değildir.
Bu önerilerin yönergeler Google, bir projeyi açık kaynaklı hale getirirken kullanır.