मुख्य सामग्री पर जाएँ

बदलाव सबमिट करना

यह गाइड Rayforge में कोड सुधार योगदान देने की प्रक्रिया कवर करती है.

फ़ीचर शाखा बनाएँ​

अपने बदलावों के लिए एक वर्णनात्मक शाखा बनाएँ:

git checkout -b feature/your-feature-name
# or
git checkout -b fix/issue-number-description

अपने बदलाव करें​

  • मौजूदा कोड शैली और परंपराओं का पालन करें
  • स्पष्ट संदेशों के साथ साफ़, केंद्रित कमिट करें
  • नई कार्यक्षमता के लिए परीक्षण जोड़ें
  • आवश्यकता अनुसार दस्तावेज़ीकरण अपडेट करें

अपने बदलावों का परीक्षण करें​

कुछ भी टूटा न हो सुनिश्चित करने के लिए पूर्ण परीक्षण सूट चलाएँ:

# Run all tests and linting
pixi run test
pixi run lint

अपस्ट्रीम के साथ सिंक करें​

पुल अनुरोध बनाने से पहले, अपस्ट्रीम रिपॉज़िटरी के साथ सिंक करें:

# Fetch the latest changes
git fetch upstream

# Rebase your branch on the latest main
git rebase upstream/main

पुल अनुरोध सबमिट करें​

  1. अपनी शाखा अपने फ़ोर्क पर पुश करें:

    git push origin feature/your-feature-name

  2. GitHub पर एक पुल अनुरोध बनाएँ और पुल अनुरोध टेम्पलेट भरें:

    • एक स्पष्ट शीर्षक और बदलाव तथा उसके हल की समस्या का विवरण
    • आपने अपना विशिष्ट आर्किटेक्चरल दृष्टिकोण क्यों चुना और कौन से विकल्प छोड़े
    • बदलाव का स्थानीय रूप से परीक्षण करने के सटीक चरण
    • किसी भी संबंधित समस्या का संदर्भ
    • यदि बदलाव UI को प्रभावित करता है तो स्क्रीनशॉट
    • टेम्पलेट की चेकलिस्ट के सभी चेकबॉक्स चिह्नित
टेम्पलेट लागू

जो पुल अनुरोध टेम्पलेट नहीं भरते उन्हें एक बॉट द्वारा स्वतः बंद कर दिया जाता है। पुल अनुरोध विवरण को संपादित करें ताकि हर खंड भरा हो और हर चेकबॉक्स चिह्नित हो — पुल अनुरोध फिर स्वतः फिर से खुल जाता है।

कोड समीक्षा प्रक्रिया​

  • सभी पुल अनुरोधों को मर्ज होने से पहले समीक्षा चाहिए
  • प्रतिक्रिया पर तुरंत कार्य करें और अनुरोधित बदलाव करें
  • चर्चा को केंद्रित और रचनात्मक रखें

मर्ज आवश्यकताएँ​

पुल अनुरोध तब मर्ज होते हैं जब वे:

  • सभी स्वचालित परीक्षण पास करते हैं
  • परियोजना की कोडिंग शैली का पालन करते हैं
  • नई कार्यक्षमता के लिए उपयुक्त परीक्षण शामिल करते हैं
  • आवश्यकता होने पर दस्तावेज़ीकरण अपडेट रखते हैं
  • कम से कम एक अनुरक्षक द्वारा स्वीकृत हों

एआई-सहायता प्राप्त कोड​

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

एआई-जनित कोड अक्सर सूक्ष्म बग, आर्किटेक्चरल बेमेल और सुरक्षा दोष पेश करता है। जो पुल अनुरोध बिना समीक्षा वाली कच्ची एआई आउटपुट प्रतीत होंगे, उन्हें maintainer के समय का सम्मान करने के लिए बंद कर दिया जाएगा।

अतिरिक्त दिशानिर्देश​

कमिट संदेश​

स्पष्ट, वर्णनात्मक कमिट संदेश उपयोग करें:

  • बड़े अक्षर से शुरू करें
  • पहली पंक्ति 50 वर्णों से कम रखें
  • आज्ञार्थ भाव उपयोग करें ("Add feature", "Added feature" नहीं)
  • आवश्यकता होने पर मुख्य भाग में अधिक विवरण शामिल करें

छोटे, केंद्रित बदलाव​

पुल अनुरोधों को एकल सुविधा या ठीक पर केंद्रित रखें. बड़े बदलाव छोटे, तार्किक टुकड़ों में तोड़े जाने चाहिए.

पहले चर्चा करें

बड़े बदलावों के लिए, महत्वपूर्ण समय लगाने से पहले अपना दृष्टिकोण चर्चा करने के लिए पहले एक समस्या खोलें.

सहायता चाहिए?

यदि आप योगदान प्रक्रिया के किसी भी भाग के बारे में अनिश्चित हैं, तो किसी समस्या या चर्चा में सहायता माँगने में संकोच न करें.