Ö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ışması posta listesinde 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 aşağıdaki yönergeleri uygulamanızı öneririz:
Starlark adlarını adlandırma
Dokümanlarda Yeni Starlark kurallarını dağıtma bölümüne bakın.
Bazel ile ilgili diğer araçlara ad verme
Bu bölüm, Bazel ekosistemini zenginleştirmek için oluşturulmuş bir araç geliştiriyorsanı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 olmamamız ve çok fazla kod adı kullanmadığımız takdirde Bazel ekosisteminin yeni başlayanlar için anlaşılması çok zor olabilir.
Bazel araçlarını adlandırmak için şu yönergeleri uygulayın:
Yeni bir marka adı tanıtmamayı tercih ediyoruz: "Bazel", kullanıcılarımız için zaten yeni bir marka. Çok fazla sayıda yeni adla karıştırmamanızı öneririz.
"Bazel" kelimesini içeren bir ad kullanmayı tercih edin: Bu, Bazel ile ilgili bir araç olduğunu açıklamaya yardımcı olur ve kullanıcıların onu bir arama motoruyla bulmasına yardımcı olur.
Aracın işlevini açıklayan adlar kullanmayı tercih edin: İdeal olan, adın kullanıcılar tarafından ne işe yaradığı konusunda iyi bir fikir edinilmesini gerektiren bir alt başlık olmamasıdır. İngilizce sözcükleri boşlukla ayırarak bu yöntemi kullanabilirsiniz.
Çiçek veya yemek teması kullanmak gerekmez: Bazel, bitki olan basil'i çağrıştırır. Bitki, yiyecek veya "fesleğen" ile ilgili bir ad aramanız gerekmez.
Aracınız başka bir üçüncü taraf markasıyla ilgiliyse bunu yalnızca açıklayıcı olarak kullanın: Örneğin, "Cmake Bazel göçmen" yerine "Cmake için Bazel göçmen" ifadesini kullanın.
Bu yönergeler, GitHub deposu URL'si için de geçerlidir. Depo URL'sini okumak, kullanıcıların aracın ne yaptığını anlamasına yardımcı olmalıdır. Elbette, depo adı daha kısa olabilir ve boşluk yerine küçük harf kullanmalıdır.
İyi ad örnekleri:
- Eclipse için Bazel: Kullanıcılar, Bazel'ı Eclipse ile kullanmak istediklerinde nereye bakmaları gerektiğini anlar. Açıklayıcı olarak bir üçüncü taraf markayı kullanır.
- Bazel derleme çiftliği: "Derleme çiftliği" bir derleme çiftliğidir. Kullanıcılar, bu projenin sunucular üzerinde derlemeyle ilgili olduğunu anlar.
Kaçınılması gereken ad örnekleri:
- Ocimum: Bazel'in bilimsel adı Bazel projesiyle yeterince ilişkili değil.
- Bazelizer: Bu adın arkasındaki araç birçok şey yapabilir. Bu ad yeterince açıklayıcı değildir.
Bu önerilerin, Google'ın bir projeyi açık kaynaklı hale getirmede kullandığı yönergelerle uyumlu olduğunu unutmayın.