Zoo Code में योगदान

Zoo Code एक समुदाय-संचालित परियोजना है, और हम हर योगदान को बहुत महत्व देते हैं। सहयोग को सुव्यवस्थित करने के لیے, हम पहले-समस्या दृष्टिकोण पर काम करते हैं, जिसका अर्थ है कि सभी पुल अनुरोध (पीआर) पहले एक गिटहब समस्या से जुड़े होने चाहिए। कृपया इस गाइड की सावधानीपूर्वक समीक्षा करें।

विषय-सूची

• योगदान करने से पहले
• अपना योगदान ढूँढना और योजना बनाना
• विकास और प्रस्तुत करने की प्रक्रिया
• पुल अनुरोध की अपेक्षाएँ
• एआई-सहायता प्राप्त योगदान
• कानूनी

योगदान करने से पहले

1. आचार संहिता

सभी योगदानकर्ताओं को हमारी आचार संहिता का पालन करना होगा।

2. परियोजना का रोडमैप

हमारा रोडमैप परियोजना की दिशा का मार्गदर्शन करता है। अपने योगदानों को इन प्रमुख लक्ष्यों के साथ संरेखित करें:

विश्वसनीयता पहले

• सुनिश्चित करें कि डिफ़ संपादन और कमांड निष्पादन लगातार विश्वसनीय हैं।
• नियमित उपयोग को रोकने वाले घर्षण बिंदुओं को कम करें।
• सभी लोकेल और प्लेटफार्मों पर सुचारू संचालन की गारंटी दें।
• विभिन्न प्रकार के एआई प्रदाताओं और मॉडलों के लिए मजबूत समर्थन का विस्तार करें।

उन्नत उपयोगकर्ता अनुभव

• स्पष्टता और सहजता के लिए यूआई/यूएक्स को सुव्यवस्थित करें।
• दैनिक उपयोग के उपकरणों के लिए डेवलपर्स की उच्च अपेक्षाओं को पूरा करने के लिए वर्कफ़्लो में लगातार सुधार करें।

एजेंट प्रदर्शन में अग्रणी

• वास्तविक दुनिया की उत्पादकता को मापने के लिए व्यापक मूल्यांकन बेंचमार्क (evals) स्थापित करें।
• सभी के लिए इन मूल्यांकनों को आसानी से चलाना और व्याख्या करना आसान बनाएं।
• ऐसे सुधार भेजें जो मूल्यांकन स्कोर में स्पष्ट वृद्धि प्रदर्शित करते हैं।

अपने पीआर में इन क्षेत्रों के साथ संरेखण का उल्लेख करें।

3. Zoo Code समुदाय से जुड़ें

• Discord: हमारे Discord से जुड़ें।
• Reddit: हमारे Reddit से जुड़ें।

अपना योगदान ढूँढना और योजना बनाना

योगदान के प्रकार

• बग फिक्स: कोड समस्याओं का समाधान करना।
• नई सुविधाएँ: कार्यक्षमता जोड़ना।
• दस्तावेज़ीकरण: गाइड और स्पष्टता में सुधार।

समस्या-पहले दृष्टिकोण

सभी योगदान हमारे पतले टेम्पलेट्स का उपयोग करके एक गिटहब समस्या से शुरू होते हैं।

• मौजूदा समस्याओं की जाँच करें: गिटहब समस्याएँ में खोजें।
• एक समस्या बनाएँ का उपयोग करके:
  • सुधार: "सुधार अनुरोध" टेम्पलेट (उपयोगकर्ता लाभ पर केंद्रित सरल भाषा)।
  • बग: "बग रिपोर्ट" टेम्पलेट (न्यूनतम प्रतिकृति + अपेक्षित बनाम वास्तविक + संस्करण)।
• इस पर काम करना चाहते हैं? समस्या पर "दावा करना" टिप्पणी करें और असाइन होने के लिए डिस्कॉर्ड पर मुख्य टीम से संपर्क करें। असाइनमेंट की पुष्टि थ्रेड में की जाएगी।
• पीआर को समस्या से लिंक करना होगा। अनलिंक किए गए पीआर बंद किए जा सकते हैं।

क्या काम करना है यह तय करना

• Issues के लिए GitHub Issues page देखें।
• दस्तावेज़ों के लिए, Zoo Code दस्तावेज़ पर जाएँ।

बग की रिपोर्ट करना

• पहले मौजूदा रिपोर्ट की जाँच करें।
• "बग रिपोर्ट" टेम्पलेट का उपयोग करके एक नया बग बनाएँ:
  • स्पष्ट, क्रमांकित पुनरुत्पादन चरण
  • अपेक्षित बनाम वास्तविक परिणाम
  • Zoo Code संस्करण (आवश्यक); यदि प्रासंगिक हो तो एपीआई प्रदाता/मॉडल
• सुरक्षा समस्याएँ: सुरक्षा सलाहकारों के माध्यम से निजी तौर पर रिपोर्ट करें।

विकास और प्रस्तुत करने की प्रक्रिया

विकास सेटअप

1. फोर्क और क्लोन:

git clone https://github.com/YOUR_USERNAME/Zoo-Code.git

2. निर्भरताएँ स्थापित करें:

pnpm install

3. डीबगिंग: वीएस कोड (F5) के साथ खोलें।

कोड लिखने के दिशानिर्देश

• प्रति सुविधा या फिक्स एक केंद्रित पीआर।
• ESLint और TypeScript की सर्वोत्तम प्रथाओं का पालन करें।
• समस्याओं का संदर्भ देने वाले स्पष्ट, वर्णनात्मक कमिट लिखें (उदाहरण के लिए, फिक्स #123)।
• पूरी तरह से परीक्षण प्रदान करें (npm test)।
• प्रस्तुत करने से पहले नवीनतम main शाखा पर रीबेस करें।

एक पुल अनुरोध सबमिट करना

• यदि आप जल्दी प्रतिक्रिया चाहते हैं तो ड्राफ्ट पीआर के रूप में शुरू करें।
• पुल अनुरोध टेम्पलेट का पालन करते हुए अपने परिवर्तनों का स्पष्ट रूप से वर्णन करें।
• पीआर विवरण/शीर्षक में समस्या को लिंक करें (उदाहरण के लिए, "फिक्स #123")।
• यूआई परिवर्तनों के लिए स्क्रीनशॉट/वीडियो प्रदान करें।
• इंगित करें कि क्या दस्तावेज़ीकरण अद्यतन आवश्यक हैं।

पुल अनुरोध नीति

• एक असाइन की गई गिटहब समस्या का संदर्भ देना होगा। असाइन होने के लिए: समस्या पर "दावा करना" टिप्पणी करें और डिस्कॉर्ड पर मुख्य टीम से संपर्क करें। असाइनमेंट की पुष्टि थ्रेड में की जाएगी।
• अनलिंक किए गए पीआर बंद किए जा सकते हैं।
• पीआर को सीआई परीक्षण पास करना होगा, रोडमैप के साथ संरेखित होना होगा, और स्पष्ट दस्तावेज़ीकरण होना होगा।

समीक्षा प्रक्रिया

• दैनिक ट्राइएज: अनुरक्षकों द्वारा त्वरित जाँच।
• साप्ताहिक गहन समीक्षा: व्यापक मूल्यांकन।
• प्रतिक्रिया के आधार पर तुरंत पुनरावृति करें।

पुल अनुरोध की अपेक्षाएँ

पुल अनुरोध समीक्षा योग्य, परीक्षित और रखरखाव योग्य होने चाहिए। पीआर खोलने से पहले, सुनिश्चित करें कि:

• परिवर्तन किसी विशिष्ट समस्या, बग या सुधार तक सीमित है।
• आप समझा सकते हैं कि परिवर्तन क्या करता है और यह सही क्यों है।
• आपने जहाँ व्यावहारिक हो, परिवर्तन को स्थानीय रूप से परीक्षित किया है।
• आप समीक्षा प्रतिक्रिया का जवाब देने और उचित अनुवर्ती परिवर्तन करने के लिए तैयार हैं।
• पीआर के लिए अनुरक्षकों को विलय से पहले कार्यान्वयन को मूल रूप से फिर से लिखने, पुनर्डिज़ाइन करने या स्वामित्व लेने की आवश्यकता नहीं है।

अनुरक्षक ऐसी पीआर को बंद कर सकते हैं जो अधूरी, बहुत व्यापक, निष्क्रिय, परियोजना की दिशा के अनुरूप नहीं, या जो असंगत समीक्षा या रखरखाव बोझ पैदा करती हों। पीआर को बंद करना योगदानकर्ता पर कोई निर्णय नहीं है; यह अनुरक्षकों का निर्णय है कि परिवर्तन अपने वर्तमान स्वरूप में स्वीकार नहीं किया जा सकता।

एआई-सहायता प्राप्त योगदान

एआई उपकरणों का उपयोग अनुमत है, लेकिन योगदानकर्ता अपनी प्रस्तुतियों के लिए पूरी तरह जिम्मेदार रहते हैं।

यदि आप पीआर बनाने में सहायता के लिए एआई उपकरणों का उपयोग करते हैं, तो आपको:

• हर महत्वपूर्ण परिवर्तन की समीक्षा करनी और समझनी होगी।
• अपने शब्दों में कार्यान्वयन और ट्रेडऑफ़ समझाने में सक्षम होना होगा।
• परिवर्तन को स्वयं परीक्षित करना होगा। यदि आपके परिवेश में परीक्षण व्यावहारिक नहीं है, तो पीआर विवरण में कारण बताएं और वर्णन करें कि समीक्षक परिवर्तन को कैसे सत्यापित कर सकते हैं।
• यह सत्यापित करना होगा कि उत्पन्न कोड सही, आवश्यक और परियोजना लाइसेंस के अनुकूल है।
• पीआर विवरण में एआई सहायता का खुलासा करने पर विचार करें जब इसने कोड, परीक्षण या डिज़ाइन को महत्वपूर्ण रूप से आकार दिया हो — इससे समीक्षकों को बेहतर प्रतिक्रिया देने में मदद मिलती है।

कृपया ऐसे एआई-उत्पन्न परिवर्तन प्रस्तुत न करें जिन्हें आप नहीं समझते या समीक्षा के दौरान बनाए नहीं रख सकते। अनुरक्षक ऐसी पीआर को बंद कर सकते हैं जो काफी हद तक एआई-सहायता प्राप्त प्रतीत होती हैं लेकिन मानवीय सत्यापन, स्पष्ट तर्क या समीक्षा अनुवर्ती का अभाव है।

कानूनी

योगदान करके, आप सहमत हैं कि आपके योगदान अपाचे 2.0 लाइसेंस के तहत लाइसेंस प्राप्त होंगे, जो Zoo Code के लाइसेंस के अनुरूप है।