पहले-पक्ष का प्लगिन जोड़ना

प्लगिन के बारे में ज़्यादा पढ़ें

प्रक्रिया

प्लग इन चार चरणों से होकर गुज़रते हैं: सुझाव देना, चर्चा करना, लागू करना, और पब्लिश करना.

सुझाव

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

सुविधा का अनुरोध लिखने के तरीके के बारे में पढ़ें

सुविधा के अनुरोध की बुनियादी जानकारी के अलावा, प्लगिन के सुझाव में ये चीज़ें भी शामिल होनी चाहिए:

  • वह एपीआई जिसे प्लगिन ज़ाहिर करेगा.
  • ऐसे एपीआई जिन्हें प्लगिन के साथ काम करने के लिए, Core Blockly में जोड़ना या बदलना ज़रूरी है.
  • अगर प्लगिन में यूज़र इंटरफ़ेस (यूआई) सुविधाएं शामिल हैं, तो स्क्रीनशॉट, GIF या मॉक-अप.
  • इस बारे में जानकारी कि इसे तीसरे पक्ष के प्लगिन के बजाय पहले-पक्ष का प्लगिन क्यों होना चाहिए.

ब्लॉकली टीम, सुझावों के आते ही उनकी समीक्षा करती है और समस्या को बंद कर देती है या स्थिति: चर्चा लेबल जोड़ती है.

चर्चा

इसके बाद, प्लगिन चर्चा के चरण में चला जाता है. इस चरण में ये चीज़ें शामिल हैं:

  • ज़रूरी फ़ंक्शन के बारे में जानकारी.
  • प्लगिन के एपीआई के बारे में जानकारी.
  • लागू करने की योजना बनाई जा रही है.
  • जांच की योजना बनाना.
  • मुख्य ब्लॉकली में एपीआई में हुए बदलावों के बारे में चर्चा.
  • बड़े प्लग इन को लागू करने के चरणों में तोड़ना.
  • हमारी नाम रखने की परंपराओं के आधार पर प्लग इन का नाम.
  • पहले पक्ष की सभी ज़रूरी शर्तें पूरी की जाएंगी.

आम तौर पर, यह चर्चा GitHub से जुड़ी समस्या पर होती है. प्लगिन का स्कोप जितना छोटा होता है, बातचीत के चरण को उतना ही तेज़ी से पूरा किया जा सकता है. बड़े प्लग इन, सही समाधान के बारे में समुदाय का ध्यान खींच सकते हैं. साथ ही, उनकी राय बेहतर तरीके से बता सकते हैं. अगर आपकी समस्या से यह समस्या हल हुई है, तो यह अच्छी बात है! आपको ऐसा कुछ मिला है जो लोगों को पसंद आता है.

हमारा लक्ष्य है कि चर्चा के चरण के आखिर में, डिज़ाइन से जुड़े सभी बड़े फ़ैसले लिए जाएं और इन्हें लागू करने के चरणों की एक साफ़ सूची हो. इस मुद्दे पर टिप्पणियों में इन दोनों की जानकारी शामिल की जानी चाहिए.

चर्चा के दौरान, हम यह तय कर सकते हैं कि प्लगिन, तीसरे पक्ष का प्लगिन होना चाहिए और उसे @blockly के दायरे में पब्लिश नहीं किया जाना चाहिए. उस मामले में, हम बताएंगे कि इस समस्या को क्यों और बंद किया गया है.

चर्चा पूरी होने के बाद, Blockly की टीम का कोई सदस्य, समस्या पर status: लागू करना लेबल जोड़ देता है.

लागू करने का तरीका

लागू करने के चरणों में ये शामिल हैं:

  • टेंप्लेट से प्लगिन और उसकी डायरेक्ट्री को सेट अप करने के लिए, npx @blockly/create-package चलाया जा रहा है. ज़्यादा जानें...
  • प्लगिन के लिए मुख्य लॉजिक लागू करना.
  • ज़रूरत पड़ने पर यूज़र इंटरफ़ेस (यूआई) लागू करना.
  • मोका का इस्तेमाल करके, प्लगिन की जांच करना.
  • README के साथ-साथ प्लगिन का दस्तावेज़ बनाना.

अगर किसी प्लगिन की समस्या पर status: लागू करना लेबल है, तो इसका मतलब है कि वह लागू करने के लिए तैयार है या उसे अभी लागू किया जा रहा है. दोहराव से बचने के लिए, दिलचस्पी रखने वाले सभी लोगों को इस समस्या पर टिप्पणी करनी चाहिए. साथ ही, उनसे पूछना चाहिए कि क्या अब भी योगदान दिया जा सकता है.

ऐसा हो सकता है कि एक साथ कई लोग योगदान दे रहे हों. अपने खुद के फ़ोर्क पर या इस रिपॉज़िटरी के लिए पुल अनुरोधों के ज़रिए, प्लगिन लागू किया जा सकता है. अगर आपको इस डेटा स्टोर करने की जगह के किसी प्लगिन पर साथ मिलकर काम करना है, तो Blockly की टीम से सुविधा की एक ब्रांच बनाने के लिए कहें.

प्लग इन को ब्लॉकली-सैंपल की master ब्रांच में मौजूद gh-pages/index.md फ़ाइल में जोड़ा जाना चाहिए. इससे वे हमारी प्लगिन साइट पर दिखेंगे. पहले-पक्ष के प्लग इन अपने टेस्ट पेज पर ले जाने चाहिए. तीसरे पक्ष के प्लग इन भी इस पेज पर जोड़े जा सकते हैं. 'यह उनके मालिक की पसंद के लिंक' पर ले जा सकता है, जैसे कि होस्ट किया गया डेमो या एनपीएम पेज.

कॉन्टेंट पब्लिश करना

आखिर में, पब्लिश हो रहा है. ब्लॉकली टीम, सभी प्लग इन का वर्शन और पब्लिश करने के लिए Lerna का इस्तेमाल करती है.

हर गुरुवार को, पिछली रिलीज़ के बाद हुए सभी प्लगिन में हुए बदलाव पब्लिश कर दिए जाते हैं. अगर आपको किसी बदलाव को जल्द पब्लिश करना है, तो कृपया अपने पुल के अनुरोध में उसे नोट करें.

जब भी प्लग इन पब्लिश किए जाते हैं, तो Plugins साइट भी अपडेट कर दी जाती है.

जो प्लग इन पब्लिश करने के लिए तैयार नहीं हैं उन्हें अपने package.json में private के तौर पर मार्क किया जाना चाहिए. ऐसा तब हो सकता है, जब कोई प्लगिन core Blockly में अभी तक पब्लिश नहीं हुए बदलाव पर निर्भर करता है. Core Blockly, हर तिमाही के आखिरी हफ़्ते में (हर तीन महीने में एक बार) पब्लिश किया जाता है.