Bazel से जुड़े प्रोजेक्ट को नाम देना

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

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

स्टारलार्क के नियमों को नाम देना

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

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

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

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

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

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

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

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

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

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

सही नामों के उदाहरण:

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

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

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

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