मुख्य कंटेंट तक स्किप करें

कोडिंग स्टैंडर्ड

✨ Snigdha OS विकास के कोडिंग स्टैंडर्ड​

Snigdha OS की उच्च गुणवत्ता वाले कोडबेस को बनाए रखने के लिए इन कोडिंग स्टैंडर्ड्स का पालन करना महत्वपूर्ण है। ये कोड की पठनीयता, रखरखाव क्षमता और सहयोग को सुनिश्चित करते हुए कोड को प्रभावी और सुरक्षित बनाते हैं। 🚀

1️⃣ नामकरण के नियम​

✅ वेरिएबल्स, फ़ंक्शंस और क्लासेज के लिए अर्थपूर्ण और वर्णनात्मक नामों का उपयोग करें।
✅ पूरे कोडबेस में एक समान नियम का पालन करें:

  • camelCase वेरिएबल्स और फ़ंक्शंस के लिए।
  • PascalCase क्लासेज और कन्स्ट्रक्टर्स के लिए।
  • snake_case कन्स्टेंट्स और कॉन्फ़िगरेशन कीज़ के लिए।

2️⃣ इंडेंटेशन और फॉर्मेटिंग​

✅ एक समान इंडेंटेशन का उपयोग करें (2 या 4 स्पेस को प्राथमिकता दें)। टैब्स का उपयोग न करें।
✅ लगातार फॉर्मेटिंग शैली का पालन करें (जैसे, ब्रेसेस की स्थिति, स्पेसिंग)।
✅ पंक्ति की लंबाई को 80-100 अक्षरों तक सीमित रखें।
✅ अनावश्यक स्पेस और टेलिंग स्पेस को हटा दें।

3️⃣ कॉमेंटिंग​

✅ जटिल लॉजिक, एल्गोरिदम या असामान्य निर्णयों को स्पष्ट करने के लिए टिप्पणी जोड़ें।
✅ टिप्पणियां संक्षिप्त, प्रासंगिक और कोड परिवर्तन के साथ मेल खाती होनी चाहिए।
✅ स्पष्ट बिंदुओं के लिए टिप्पणियाँ से बचें, जैसे कि // Incrementing i by 1।

// अच्छा उदाहरण:
function calculateTax(income) {
  // प्रगतिशील स्लैब के आधार पर टैक्स की गणना करता है।
  ...
}

4️⃣ मॉड्यूलैरिटी और कोड पुनः उपयोगिता​

✅ कोड को छोटे, पुनः उपयोग योग्य फ़ंक्शंस या मॉड्यूल में विभाजित करें।
✅ संबंधित कार्यक्षमता को वर्गों या नेमस्पेस में समूहित करें।

5️⃣ त्रुटि प्रबंधन​

✅ उचित त्रुटि प्रबंधन उपायों का उपयोग करें, जैसे try-catch ब्लॉक।
✅ त्रुटि संदेशों में आंतरिक लॉजिक को उजागर न करें।

try:
    result = perform_operation()
except ValueError as e:
    print("गलत इनपुट। कृपया फिर से प्रयास करें।")  # "ValueError: details" से बचें।

6️⃣ कोड पठनीयता​

✅ सरल और स्पष्ट कोड लिखें। अनावश्यक जटिलताओं से बचें।
✅ एकल-अक्षरों के बजाय वर्णनात्मक वेरिएबल्स और फ़ंक्शन नामों का उपयोग करें।
✅ बुद्धिमत्ता से अधिक स्पष्टता को प्राथमिकता दें।

7️⃣ एकरूप कोड शैली​

✅ उपयोग की जाने वाली प्रोग्रामिंग भाषा के स्टाइल गाइड का पालन करें (जैसे, Python के लिए PEP 8, JavaScript के लिए ESLint)।
✅ स्पेसिंग, इंडेंटेशन और ब्रेसेस की स्थिति के लिए एकरूप अभ्यास का पालन करें।

8️⃣ डॉक्युमेंटेशन​

✅ प्रत्येक फ़ंक्शन, क्लास और मॉड्यूल के लिए स्पष्ट विवरण लिखें।
✅ पैरामीटर, रिटर्न वैल्यू और संभावित त्रुटियों को डॉक्युमेंटेशन में शामिल करें।

def calculate_area(radius):
    """
    एक वृत्त का क्षेत्रफल गणना करता है।

    Args:
        radius (float): वृत्त का व्यासार्ध।

    Returns:
        float: वृत्त का क्षेत्रफल।
    """
    return 3.14 * radius ** 2

9️⃣ टेस्टिंग​

✅ सभी महत्वपूर्ण कार्यक्षमताओं के लिए यूनिट टेस्ट लिखें।
✅ कम से कम 80% कोड कवरेज सुनिश्चित करें।
✅ pytest, Jest, या JUnit जैसे फ्रेमवर्क का उपयोग करके टेस्ट को स्वचालित करें।

🔟 वर्शन कंट्रोल​

✅ वर्शन कंट्रोल के लिए Git का उपयोग करें। Git Flow जैसी ब्रांचिंग रणनीति का पालन करें।
✅ स्पष्ट और वर्णनात्मक कमिट संदेश लिखें, जैसे:

feat: उपयोगकर्ता प्रमाणीकरण के लिए फ़ीचर जोड़ा गया।  
fix: भुगतान गेटवे एकीकरण में बग हल किया।  
docs: README में इंस्टॉलेशन स्टेप्स अपडेट किए गए।

🔑 मुख्य सिद्धांत​

1️⃣ पठनीयता: ऐसा कोड लिखें जिसे छह महीने बाद आप स्वयं समझ सकें।
2️⃣ मॉड्यूलैरिटी: कोड को मॉड्यूलर और अलग रखें।
3️⃣ एकरूपता: एकरूप स्टाइल अपनाएं ताकि रखरखाव आसान हो।

इन स्टैंडर्ड्स का पालन करने से कोड की गुणवत्ता में सुधार होगा और सहयोग के लिए एक पेशेवर वातावरण बनेगा। शुभ कोडिंग! 🎉👩‍💻👨‍💻