📑 सामग्री तालिका

• Carch मा योगदान

  • कोडबेस बुझ्नुहोस्
  • योगदान गर्ने चरणहरू

• Carch डकुमेन्टेशनमा योगदान

• दिशानिर्देशहरू

Carch मा योगदान

हामी तपाईंले Carch मा योगदान गर्न चासो देखाउनुभएकोमा उत्साहित छौं! सबै प्रकारका योगदानहरू स्वागत छ, चाहे तपाईंले बगहरू फिक्स गरिरहनुभएको होस्, नयाँ सुविधाहरू थप्दै हुनुहुन्छ, वा डकुमेन्टेशन सुधार गरिरहनुभएको होस्। सुरु गर्न यो गाइड पालना गर्नुहोस्।

WARNING

कुनै पनि योगदान गर्नु अघि, पहिले Feature Request खण्डमा एक इश्यू खोल्नुहोस्। कार्यान्वयनको साथ अगाडि बढ्नु अघि हामी त्यहाँ परिवर्तनहरूबारे छलफल गर्नेछौं।

📌 कोडबेस बुझ्नुहोस्

IMPORTANT

पहिले, कुनै पनि परिवर्तन गर्नु अघि स्क्रिप्ट कसरी काम गर्छ भन्ने विश्लेषण गर्नुहोस्। यदि तपाईं प्रोजेक्टलाई सुधार गर्न वा थप्न चाहनुहुन्छ भने, तपाईंले संरचना बुझ्नुभएको र प्रत्येक भाग कसरी अन्तरक्रिया गर्छ भन्ने कुरा सुनिश्चित गर्नुहोस्। यसले तपाईंलाई प्रोजेक्टको डिजाइनसँग सुसंगत तरिकाले योगदान गर्न मद्दत गर्नेछ।

कमिट गर्नका लागि, परम्परागत कमिट शैली पालना गर्नुहोस्:
feat: तपाईंको-कमिट-सन्देश वा fix: तपाईंको-कमिट-सन्देश।

वैसे, कमिट गर्नु अघि, यदि तपाईं कुनै .sh वा bash स्क्रिप्ट फाइल परिवर्तन गर्दै हुनुहुन्छ भने, scripts/ डाइरेक्टरी जाँच गर्न र कुनै अतिरिक्त सेतो वा खाली ठाउँको लागि ./check.sh चलाउन निश्चित गर्नुहोस्। यदि यो असफल भयो भने, ./cleanup.sh चलाउनुहोस्। यो पनि सुनिश्चित गर्नुहोस् कि शेल स्क्रिप्टहरू shfmt द्वारा फर्म्याट गरिएका छन्। Rust फाइल परिवर्तनहरूका लागि, cargo fmt --all --check चलाउन निश्चित गर्नुहोस्। यदि कुनै सुझावहरू छन् भने, cargo fmt --all चलाउनुहोस्। यो पनि निश्चित गर्नुहोस् कि cargo clippy र cargo clippy -- -D warnings चलाउनुहोस् ताकि कुनै त्रुटिहरू बाँकी नरहोस्। धन्यवाद।

Conventional Commits बारे थप जानकारीका लागि, यो गाइड हेर्नुहोस्।

यदि तपाईंसँग प्रश्नहरू छन् वा मद्दत चाहिन्छ भने, हामीलाई सम्पर्क गर्न नहिचकिचाउनुहोस्:
📧 इमेल: [email protected]
💬 Discord: यहाँ सामेल हुनुहोस्

योगदान गर्ने चरणहरू

1. 🍽️ रिपोजिटरी फोर्क गर्नुहोस्

• Carch GitHub पृष्ठमा जानुहोस्।
• रिपोजिटरीको आफ्नै प्रतिलिपि बनाउन माथिको दाहिने कुनामा Fork बटनमा क्लिक गर्नुहोस्।

2. 🌿 फोर्क गरिएको रिपोजिटरी क्लोन गर्नुहोस्

• तपाईंको स्थानीय सिस्टममा रिपोजिटरी क्लोन गर्न निम्न आदेश प्रयोग गर्नुहोस्:

  git clone https://github.com/your-username/carch.git

• your-username लाई आफ्नो GitHub username सँग बदल्नुहोस्।

💡 सुझाव

तपाईं GitHub Desktop जस्ता GUI उपकरणहरू वा GitHub वेब इन्टरफेस पनि प्रयोग गर्न सक्नुहुन्छ रिपोजिटरीहरू फोर्क र क्लोन गर्न। यी उपकरणहरूले तपाईंका योगदानहरू प्रबन्धन गर्नका लागि प्रयोग गर्न सजिलो दृश्य इन्टरफेस प्रदान गर्छन्।

3. 🌱 मूल रिपोजिटरीलाई Upstream को रूपमा सेट गर्नुहोस्

• तपाईंको फोर्कलाई अद्यावधिक राख्न मूल Carch रिपोजिटरीलाई upstream remote को रूपमा थप्नुहोस्:

  cd carch

  git remote add upstream https://github.com/original-author/carch.git

4. 🍇 नयाँ Feature Branch बनाउनुहोस्

• परिवर्तन गर्नु अघि, वर्णनात्मक नामको साथ नयाँ शाखा बनाउनुहोस्:

  git checkout -b feature/your-branch-name

• शाखा नामका उदाहरणहरू:

  • feature/add-new-script
  • bugfix/fix-installation-issue

5. 🔧 आफ्ना परिवर्तनहरू गर्नुहोस्

• कोड वा डकुमेन्टेशनमा आवश्यक परिवर्तनहरू लागू गर्नुहोस्।
• तपाईंका परिवर्तनहरू स्पष्ट, परीक्षण गरिएको र परियोजनाका कोडिङ मापदण्डहरू पालना गरेको सुनिश्चित गर्नुहोस्।

6. 📝 आफ्ना परिवर्तनहरू Stage र Commit गर्नुहोस्

• परिमार्जित फाइलहरूलाई staging area मा थप्नुहोस्:

  git add .

• स्पष्ट सन्देशको साथ आफ्ना परिवर्तनहरू कमिट गर्नुहोस्:

  git commit -m "Add: [तपाईंका परिवर्तनहरूको संक्षिप्त विवरण]"

7. 🚀 परिवर्तनहरूलाई आफ्नो फोर्कमा Push गर्नुहोस्

• आफ्नो शाखालाई फोर्क गरिएको रिपोजिटरीमा push गर्नुहोस्:

  git push origin feature/your-branch-name

8. 📥 Pull Request (PR) पेश गर्नुहोस्

• GitHub मा मूल Carch रिपोजिटरीमा जानुहोस्।
• New Pull Request मा क्लिक गर्नुहोस्।
• ड्रपडाउनबाट आफ्नो शाखा छान्नुहोस् र आफ्ना परिवर्तनहरूको विस्तृत विवरण दिनुहोस्।
• समीक्षाका लागि PR पेश गर्नुहोस्!

📚 Carch डकुमेन्टेशनमा योगदान

Carch Docs ➥ यहाँ लाइभ छ

🚀 योगदान गर्ने तरिकाहरू

तपाईं यसरी योगदान गर्न सक्नुहुन्छ:

• 🪛 अवस्थित गाइडहरूमा टाइपो वा गल्तीहरू फिक्स गर्दै
• 🌐 डकुमेन्टेशनलाई अन्य भाषाहरूमा अनुवाद गर्दै (अत्यधिक प्रोत्साहित!)

🌍 डकुमेन्टेशन अनुवाद गर्दै

Carch लाई विश्वभरका प्रयोगकर्ताहरूका लागि पहुँचयोग्य बनाउन मद्दत गर्न चाहनुहुन्छ? डकुमेन्टेशन अनुवाद गर्न हामीलाई मद्दत गर्नुहोस्!

यदि तपाईं नयाँ भाषा योगदान गरिरहनुभएको छ भने, यी चरणहरू पालना गर्नुहोस्:

1. 📁 docs/ डाइरेक्टरी भित्र आफ्नो भाषाका लागि नयाँ फोल्डर बनाउनुहोस्। ISO 639-1 codes प्रयोग गर्नुहोस् (जस्तै fr, es, hi, आदि)।
2. 🛠️ नयाँ फोल्डर भित्र Markdown सामग्री अनुवाد गर्नुहोस्।
3. 🧩 docs/.vitepress/config.ts परिमार्जन गर्नुहोस्:
   • locales खण्डमा आफ्नो भाषा थप्नुहोस्।
   • नेभिगेशनका लागि label, lang, र link प्रदान गर्नुहोस्।

🧪 स्थानीय रूपमा आफ्ना परिवर्तनहरू परीक्षण गर्दै

आफ्ना परिवर्तनहरूको पूर्वावलोकन गर्न:

bun install
bun run docs:dev

IMPORTANT

यदि तपाईंले प्रमुख संरचनात्मक वा संगठनात्मक परिवर्तनहरू परिचय गराउने योजना बनाउनुभएको छ भने कृपया पहिले एक इश्यू खोल्नुहोस्। हामी पहिले नै यसमा छलफल र सहयोग गर्न चाहन्छौं!

🧾 कमिट शैली

स्पष्ट कमिट सन्देशहरू प्रयोग गर्नुहोस्:

git commit -m "fix(docs): स्थापना गाइडमा टाइपो सुधार"
git commit -m "feat(docs): नेपाली अनुवाद थप्नुहोस्"

Conventional Commits मा थप।

🙌 डकुमेन्टेशन सुधार गर्न मद्दत गरेकोमा धन्यवाद!

दिशानिर्देशहरू

कोड गुणस्तर

• परियोजनाको अवस्थित कोडिङ शैली पालना गर्नुहोस्।
• स्पष्ट, संक्षिप्त र राम्रोसँग डकुमेन्ट गरिएको कोड लेख्नुहोस्।

परीक्षण

• आफ्ना परिवर्तनहरू अपेक्षित रूपमा काम गर्छ भनेर सुनिश्चित गर्न स्थानीय रूपमा परीक्षण गर्नुहोस्।
• यदि तपाईंका परिवर्तनहरूले नयाँ सुविधाहरू परिचय गराउँछ भने, लागू हुने ठाउँमा आवश्यक परीक्षणहरू थप्नुहोस्।

डकुमेन्टेशन

• यदि तपाईंका परिवर्तनहरूमा नयाँ कार्यक्षमता समावेश छ भने, सान्दर्भिक डकुमेन्टेशन अपडेट गर्नुहोस्।
• README वा Wiki ले तपाईंका अपडेटहरू प्रतिबिम्बित गर्छ भनेर सुनिश्चित गर्नुहोस्।

आफ्नो फोर्क सिंक गर्दै

• द्वन्द्वहरूबाट बच्न आफ्नो फोर्कलाई अपडेटेड राख्नुहोस्:

  git fetch upstream

  git merge upstream/main

  • यदि रिपोजिटरीको पूर्वनिर्धारित शाखा फरक छ भने main लाई बदल्नुहोस्।

Carch मा योगदान गरेकोमा धन्यवाद! तपाईंको प्रयासले यो परियोजनालाई सबैका लागि राम्रो बनाउन मद्दत गर्छ।