Jetpack Compose एपीआई के लिए स्टाइल से जुड़े दिशा-निर्देश

अगर आपको अपने ऐप्लिकेशन के लिए Compose कोड लिखना है या Compose लाइब्रेरी और एपीआई बनाने हैं, तो सबसे सही तरीके अपनाएं. इससे आपका कोड ज़्यादा बेहतर तरीके से काम करेगा, उसकी परफ़ॉर्मेंस बेहतर होगी, और वह पूरे इकोसिस्टम के साथ काम कर पाएगा.

नीचे दिए गए दस्तावेज़ों में, Compose का इस्तेमाल करके कोड लिखने वाले लोगों के लिए दिशा-निर्देश दिए गए हैं:

• Jetpack Compose के लिए एपीआई के दिशा-निर्देश: इसमें Jetpack Compose कंपाइलर प्लगिन और रनटाइम का इस्तेमाल करने वाले किसी भी सिस्टम के लिए, पैटर्न, सबसे सही तरीके, और स्टाइल से जुड़े दिशा-निर्देश दिए गए हैं. इसमें ये विषय शामिल हैं:
  • Compose के लिए Kotlin की स्टाइल से जुड़े दिशा-निर्देश, जो Kotlin Coding Conventions पर आधारित हैं
  • Compose runtime की सुविधाओं पर आधारित @Composable फ़ंक्शन और एपीआई के लिए दिशा-निर्देश
  • Compose यूज़र इंटरफ़ेस (यूआई) टूलकिट का इस्तेमाल करने और उसे बढ़ाने वाले एपीआई के लिए दिशा-निर्देश
  • Compose API डिज़ाइन करते समय, इस्तेमाल के उदाहरणों को हल करने के पैटर्न
• Jetpack Compose में @Composable कॉम्पोनेंट के लिए एपीआई से जुड़े दिशा-निर्देश: इसमें @Composable यूज़र इंटरफ़ेस (यूआई) कॉम्पोनेंट बनाने और उनका इस्तेमाल करने के लिए, दिशा-निर्देश और सुझाव दिए गए हैं. इनमें ये विषय शामिल हैं:
  • कॉम्पोनेंट बनाना और उन्हें लेयर करना
  • किसी नए कॉम्पोनेंट का नाम देना
  • कॉम्पोनेंट की डिपेंडेंसी के बारे में बताना
  • @Composable कॉम्पोनेंट में मौजूद पैरामीटर
  • कॉम्पोनेंट से जुड़ी क्लास और फ़ंक्शन बनाने के लिए सही पैटर्न का इस्तेमाल करना
  • @Composable कॉम्पोनेंट के बारे में जानकारी देना
  • कॉम्पोनेंट के लिए सुलभता को बेहतर बनाना
  • पुराने सिस्टम के साथ काम करने की सुविधा को बनाए रखते हुए, कॉम्पोनेंट एपीआई को अपडेट करना

ऑडियंस

ये दिशा-निर्देश, इन तीन तरह के लोगों के लिए लिखे गए हैं:

• Jetpack Compose के आधार पर ऐप्लिकेशन बनाने वाले डेवलपर. अगर आपने अपने ऐप्लिकेशन के किसी हिस्से में Jetpack Compose का इस्तेमाल किया है, तो आप इस ग्रुप में शामिल हैं.
• Jetpack Compose फ़्रेमवर्क को डेवलप करने वाले डेवलपर. अगर आपने androidx.compose लाइब्रेरी में योगदान दिया है, तो आपको इस ग्रुप में शामिल किया जाएगा.
• Jetpack Compose के आधार पर लाइब्रेरी बनाने वाले डेवलपर. अगर आपने Compose API या Compose UI एलिमेंट की लाइब्रेरी बनाई हैं, तो आप इस ग्रुप में शामिल हैं. Compose कॉम्पोनेंट की ये लाइब्रेरी, सार्वजनिक तौर पर उपलब्ध हो सकती हैं. इसके अलावा, ये आपकी कंपनी या टीम के लिए स्थानीय तौर पर भी उपलब्ध हो सकती हैं.

आप जिस ग्रुप में शामिल हैं उसके हिसाब से, आपको हर स्टाइल गाइड के लिए अलग-अलग लेवल की सख्ती का पालन करना होगा. उदाहरण के लिए, Jetpack Compose फ़्रेमवर्क डेवलपमेंट आम तौर पर इन दिशा-निर्देशों का सबसे ज़्यादा पालन करता है.

हर डेवलपर ऑडियंस के लिए ज़रूरी शर्तों के बारे में ज़्यादा जानने के लिए, RFC2119 देखें.

फ़्रेमवर्क और दिशा-निर्देशों में योगदान करना

हम androidx कोडबेस और स्टाइल गाइडलाइन (Compose API की गाइडलाइन और @Composable कॉम्पोनेंट की गाइडलाइन) में चुनिंदा लाइब्रेरी के लिए योगदान का स्वागत करते हैं.

योगदान देने के लिए, androidx योगदान देने से जुड़ी गाइड में दिए गए निर्देशों का पालन करें.