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

समस्या की शिकायत करें सोर्स देखें Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

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

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

Starlark नियमों का नाम रखना

दस्तावेज़ में, नए Starlark नियमों को डिप्लॉय करना लेख पढ़ें.

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

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

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

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

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

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

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

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

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

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

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

ऐसे नामों के उदाहरण जिनका इस्तेमाल नहीं किया जाना चाहिए:

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

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