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

किसी समस्या की शिकायत करें सोर्स देखें Nightly · 8.0 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

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

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

Starlark फ़ंक्शन के नाम रखने के नियम

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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