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

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

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

यहां ब्लॉकली-सैंपल के बारे में कुछ अहम जानकारी दी गई है. पीआर बनाने के लिए, आपको यह जानकारी होनी चाहिए.

• काम करने वाली ब्रांच main है और सभी पीआर, main के ख़िलाफ़ किए जाने चाहिए.
• 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/ डायरेक्ट्री में, अपने-आप होने वाले मोचा टेस्ट लिखें.
7. ऑटोमेटेड टेस्ट चलाने के लिए, npm run test चलाएं.
8. लिंट की गड़बड़ियों को ठीक करने के लिए, npm run lint:fix चलाएं. बची हुई किसी भी चेतावनी या गड़बड़ी को ठीक करें.
9. ऑटोफ़ॉर्मेटर चलाने के लिए, npm run format चलाएं.
10. अगर सभी टेस्ट पास हो जाते हैं, तो आपके पास main के ख़िलाफ़ पीआर खोलने का विकल्प होता है. इसमें आपके बदलाव शामिल होते हैं.