सैंपल में योगदान देना

Blockly के सैंपल में, Blockly से जुड़ा ऐसा कॉन्टेंट होता है जो मुख्य रिपॉज़िटरी का हिस्सा नहीं है. जैसे, प्लग इन, कोडलैब, और उदाहरण के तौर पर दिया गया कोड. इनमें से हर एक के बारे में ज़्यादा जानकारी के लिए, रिपॉज़िटरी का स्ट्रक्चर पेज देखें.

ज़रूरी जानकारी

यहां blockly-samples के बारे में खास जानकारी दी गई है. इसे जानना, पीआर बनाने के लिए ज़रूरी है.

  • काम करने वाली शाखा master है और सभी पीआर, master के लिए किए जाने चाहिए.
  • npm install को अलग-अलग प्लग इन लेवल पर नहीं,बल्कि blockly-samples के रूट लेवल पर चलाएं. Blockly-samples एक मोनोरेपो है. इसका मतलब है कि इसमें एक ही रिपॉज़िटरी में कई पैकेज होते हैं. साथ ही, इसे रूट लेवल पर इंस्टॉल करना, Lerna की मदद से मोनोरेपो को मैनेज करने के वर्कफ़्लो का हिस्सा है.
  • कोड, इस्तेमाल की गई भाषा के आधार पर, Google की JavaScript स्टाइल गाइड या TypeScript स्टाइल गाइड के मुताबिक होना चाहिए.
  • अपने कमिट मैसेज और पुल रिक्वेस्ट के टाइटल में, कन्वेंशनल कमिट का इस्तेमाल करें.

  • किसी भी नई कोड फ़ाइल के नाम में, Apache License v2.0 का प्रीफ़िक्स होना चाहिए:

    /**
 *   @license
 *   Copyright <Current YYYY> Google LLC
 *   SPDX-License-Identifier: Apache-2.0
 */

बदलाव करना और उसकी पुष्टि करना

  1. डिपेंडेंसी इंस्टॉल करने के लिए, blockly-samples के रूट लेवल पर npm install चलाएं.
  2. प्लग इन के टेस्ट पेज को चलाने वाला सर्वर बनाने और उसे शुरू करने के लिए, प्लग इन की डायरेक्ट्री में npm run start चलाएं. इस पेज का इस्तेमाल करके, किसी प्लग इन के मौजूदा व्यवहार को देखा जा सकता है. इसके अलावा, अगर कोई नया प्लग इन जोड़ा जा रहा है, तो आपको इसे एक काम का टेस्ट पेज बनाना होगा, ताकि दूसरे लोग देख सकें कि आपका प्लग इन क्या करता है. ज़्यादा जानकारी के लिए, प्लेग्राउंड पेज देखें.
  3. प्लग इन के कोड में ज़रूरी बदलाव करें.
  4. अगर आपने सर्वर को चालू रहने दिया है, तो आपके बदलाव अपने-आप लोड हो जाएंगे. अगर ऐसा नहीं होता है, तो सर्वर को रीस्टार्ट करें और पुष्टि करें कि प्लगिन ठीक से काम कर रहा है और कंसोल में कोई गड़बड़ी या चेतावनी नहीं है.
  5. npm run build चलाएं और पक्का करें कि बिल्ड में कोई गड़बड़ी न हो.
  6. test/ डायरेक्ट्री में, अपने-आप चलने वाले mocha टेस्ट लिखें.
  7. ऑटोमेटेड टेस्ट चलाने के लिए, npm run test चलाएं.
  8. लिंट की गड़बड़ियां ठीक करने के लिए, npm run lint:fix चलाएं. बाकी बची हुई चेतावनियों या गड़बड़ियों को ठीक करें.
  9. अपने-आप फ़ॉर्मैट करने की सुविधा को चलाने के लिए, npm run format चलाएं.
  10. अगर सभी टेस्ट पास हो जाते हैं, तो अपने बदलावों के साथ master के लिए एक पीआर खोला जा सकता है.