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