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

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

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

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

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