Ö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-tartışma posta listesinden Bazel topluluğuna ulaşın.
Bazel ile ilgili bir araç oluşturuyorsanız veya Skylark kurallarınızı paylaşıyorsanız projenizin adı için şu yönergeleri uygulamanızı öneririz:
Starlark kurallarını adlandırma
Belgelerde Yeni Starlark kurallarını dağıtma bölümüne bakın.
Bazel ile ilgili diğer araçları adlandırma
Bu bölüm, Bazel ekosistemini zenginleştirecek bir araç oluşturuyorsanız geçerlidir. Örneğin, yeni bir IDE eklentisi veya yeni bir derleme sistemi taşıma aracı.
Aracınız için iyi bir ad seçmek zor olabilir. Dikkatli olmaz ve çok fazla kod adı kullanırsak Bazel ekosistemini yeni başlayanlar açısından çok zor anlayabiliriz.
Bazel araçlarını adlandırmak için aşağıdaki yönergeleri uygulayın:
Yeni bir marka adı eklemekten kaçının: "Bazel" kullanıcılarımız için zaten yeni bir marka. Kullanıcıları çok fazla yeni adla karıştırmaktan kaçınmalıyız.
"Bazel" içeren bir ad kullanmayı tercih et: Bu, aracın Bazel ile ilgili bir araç olduğunu ifade etmeye ve kullanıcıların arama motoruyla bulmasına yardımcı olur.
Aracın işlevini açıklayan adlar kullanmayı tercih edin: İdeal olarak, aracın ne yaptığını ilk kez iyi bir şekilde tahmin etmek için adın altyazıya ihtiyacı olmamalıdır. İngilizce kelimeleri boşlukla ayırarak kullanarak bunu başarabilirsiniz.
Çiçek veya gıda teması kullanmak zorunlu değildir: Bazel, fesleğen adlı bitkiyi hatırlatır. Bitki, yiyecek ya da “fesleğen” ile ilgili bir isim aramanıza gerek yoktur.
Aracınız başka bir üçüncü taraf markasıyla ilgiliyse yalnızca açıklayıcı olarak kullanın: Örneğin, "Cmake Bazel taşıma aracı" yerine "Cmake için Bazel taşıma aracı"nı kullanın.
Bu yönergeler, GitHub kod deposu URL'si için de geçerlidir. Depo URL'sini okumak, kullanıcıların aracın ne yaptığını anlamalarına yardımcı olmalıdır. Elbette, deposun adı daha kısa olabilir ve boşluk ve küçük harf yerine kısa çizgi kullanılmalıdır.
İyi adlara örnekler:
- Eclipse için Bazel: Kullanıcılar, Bazel'i Eclipse ile kullanmak istemeleri durumunda nereye gitmeleri gerektiğini anlayacaktır. Tanımlayıcı olarak bir üçüncü taraf markası kullanıyor.
- Bazel derleme çiftliği: "buildfarm", bir derleme çiftliktir. Kullanıcılar, bu projenin sunucularda derlemeyle ilgili olduğunu anlayacaktır.
Kaçınılması gereken ad örnekleri:
- Ocimum: Fasilin bilimsel adı Bazel projesiyle yeterince alakalı değil.
- Bazelizer: Bu adın ardındaki araç birçok şey yapabilir; bu ad yeterince açıklayıcı değildir.
Bu önerilerin, Google'ın bir projeyi açık kaynaklı hale getirirken kullandığı kurallara uygun olduğunu unutmayın.