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

सबसे पहले, Bazel के इकोसिस्टम में योगदान देने के लिए धन्यवाद! अपने प्रोजेक्ट और उसके सुझाए गए नाम के बारे में बताने के लिए, कृपया bazel-discuss मेलिंग सूची पर 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" एक कंपाइल फ़ार्म है. उपयोगकर्ताओं को यह समझ में आ जाएगा कि यह प्रोजेक्ट, सर्वर पर बनाने से जुड़ा है.

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

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

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