कोर में योगदान देना

Blockly की मुख्य रिपॉज़िटरी में, Blockly पर आधारित किसी भी ऐप्लिकेशन को चलाने के लिए ज़रूरी कोड होता है.

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

पीआर बनाने के लिए, Blockly कोर के बारे में यहां कुछ ज़रूरी जानकारी दी गई है.

• काम करने वाली ब्रांच main है और सभी पीआर, main के ख़िलाफ़ किए जाने चाहिए.
• आपको पुल अनुरोध के टेम्प्लेट में मांगी गई जानकारी भरनी होगी.
• कोड, Google की टाइपस्क्रिप्ट स्टाइल गाइड के मुताबिक होना चाहिए.
• अपने कमिट मैसेज और पुल अनुरोध के टाइटल में, कन्वेंशनल कमिट का इस्तेमाल करें.
• उपयोगकर्ता को दिखने वाली स्ट्रिंग, /msg/messages.js फ़ाइल में होनी चाहिए, ताकि उनका अनुवाद किया जा सके. दुनिया के 6% से भी कम लोग, अंग्रेज़ी को अपनी पहली भाषा के तौर पर बोलते हैं.
• ब्लॉक पर मौजूद टेक्स्ट आम तौर पर, सभी छोटे अक्षरों में होना चाहिए. ठीक वैसे ही जैसे ज़्यादातर प्रोग्रामिंग भाषाओं में कीवर्ड होते हैं.
• पुराने सिस्टम के साथ काम करने की सुविधा को बनाए रखना. Blockly के कई ऐप्लिकेशन उपलब्ध हैं. इसलिए, किसी और के ऐप्लिकेशन में गड़बड़ी न करें.

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

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

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

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