बैजल से जुड़े प्रोजेक्ट का नाम रखना

किसी समस्या की शिकायत करें स्रोत देखें

सबसे पहले, Bazel नेटवर्क में योगदान देने के लिए धन्यवाद! अपने प्रोजेक्ट और सुझाए गए नाम को शेयर करने के लिए, कृपया bazel-चर्चा मेल सूची पर बेज़ल समुदाय से संपर्क करें.

अगर आप बेज़ल से जुड़े टूल बना रहे हैं या स्काईलार्क के नियम शेयर कर रहे हैं, तो हमारा सुझाव है कि आप अपने प्रोजेक्ट का नाम रखने के लिए, इन दिशा-निर्देशों का पालन करें:

नाम रखने के लिए स्टारलार्क के नियम

दस्तावेज़ों में नए Starlark नियमों को लागू करना देखें.

अगर आप बेज़ल नेटवर्क को बेहतर बनाने के लिए टूल बना रहे हैं, तो यह सेक्शन लागू होगा. उदाहरण के लिए, नया IDE प्लग इन या नया बिल्ड सिस्टम माइग्रेटर.

अपने टूल के लिए सही नाम चुनना मुश्किल हो सकता है. अगर हम सावधान नहीं हैं और बहुत सारे कोडनेम का इस्तेमाल करते हैं, तो हो सकता है कि बज़ेल नेटवर्क को नए लोगों के लिए समझना मुश्किल हो जाए.

Bazel टूल का नाम रखने के लिए, इन दिशा-निर्देशों का पालन करें:

  1. कोई नया ब्रैंड नाम पेश न करना: "Bazel", हमारे उपयोगकर्ताओं के लिए पहले से ही एक नया ब्रैंड है, इसलिए हमें ज़्यादा नए नामों को लेकर उन्हें भ्रम में डालने से बचना चाहिए.

  2. ऐसे नाम का इस्तेमाल करना जिसमें "Bazel" शामिल हो: इससे यह बताने में मदद मिलती है कि यह Bazel से जुड़ा टूल है और लोगों को सर्च इंजन का इस्तेमाल करके इसे ढूंढने में भी मदद मिलती है.

  3. ऐसे नामों का इस्तेमाल करें जो इस बारे में जानकारी देते हों कि टूल क्या कर रहा है: आम तौर पर, नाम ऐसा होना चाहिए जिससे उपयोगकर्ता को सबसे पहले यह अंदाज़ा लगाने में मदद मिले कि टूल क्या करता है. अंग्रेज़ी के शब्दों को स्पेस से अलग करके, इस्तेमाल किया जा सकता है.

  4. किसी फूल या खाने की थीम का इस्तेमाल करने की ज़रूरत नहीं है: बज़ल ने पौधे की तुलसी बनाई. आपको कोई ऐसा नाम ढूंढने की ज़रूरत नहीं है जो किसी पौधे, भोजन या "तुलसी" से मिलता-जुलता हो.

  5. अगर आपका टूल तीसरे पक्ष के किसी दूसरे ब्रैंड से जुड़ा है, तो उसका इस्तेमाल सिर्फ़ जानकारी देने वाले के तौर पर करें: उदाहरण के लिए, "Cmake Bazel migrator" के बजाय, "Cmake के लिए बेगल माइग्रेटर" का इस्तेमाल करें.

ये दिशा-निर्देश, GitHub के डेटा स्टोर करने की जगह के यूआरएल पर भी लागू होते हैं. रिपॉज़िटरी यूआरएल पढ़ने से लोगों को यह समझने में मदद मिलेगी कि टूल क्या करता है. बेशक, डेटा स्टोर करने की जगह का नाम छोटा हो सकता है और उसमें स्पेस और अंग्रेज़ी के छोटे अक्षरों के बजाय डैश का इस्तेमाल करना चाहिए.

अच्छे नामों के उदाहरण:

  • Eclipse के लिए बेजल: उपयोगकर्ताओं को यह समझ आ जाएगा कि अगर वे Eclipse के साथ बैजल का इस्तेमाल करना चाहते हैं, तो उन्हें यहां देखना चाहिए. यह एक वर्णनकर्ता के रूप में एक तृतीय पक्ष ब्रांड का उपयोग करता है.
  • Bazel buildfarm: "buildfarm" कंपाइल फ़ार्म है. उपयोगकर्ताओं को यह समझ आ जाएगा कि यह प्रोजेक्ट सर्वर पर बनाए जाने से जुड़ा है.

ऐसे नामों के उदाहरण जिनसे बचें:

  • ओसीमम: तुलसी का वैज्ञानिक नाम, बेज़ल प्रोजेक्ट से मिलता-जुलता नहीं है.
  • Bazelizer: इस नाम के टूल में बहुत-सी चीज़ें हो सकती हैं, यह नाम पूरी जानकारी नहीं देता.

ध्यान दें कि ये सुझाव, उन दिशा-निर्देशों के मुताबिक होते हैं जिनका इस्तेमाल Google, किसी प्रोजेक्ट को ओपन सोर्स करने के लिए करता है.