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

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

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

यहां ब्लॉकली-सैंपल के उन तथ्यों के बारे में खास जानकारी दी गई है जिन्हें पीआर बनाने के लिए जानना ज़रूरी है.

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

• किसी भी नई कोड फ़ाइल के साथ Apache लाइसेंस v2.0 जोड़ा जाना ज़रूरी है:

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

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

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