Remote Valley OS मा योगदान गर्नुहोस्
स्वागत छ। तपाईं यहाँ हुनुहुन्छ, हामी खुसी छौं।
Remote Valley OS तपाईंजस्ता मानिसहरूले बनाएको खुला स्रोत परियोजना हो। हरेक योगदान — कोडको एक लाइन, अनुवाद, बग रिपोर्ट वा टाइपो सुधार — ले परियोजनालाई बलियो बनाउँछ र संसारभरका दुर्गम समुदायलाई सहयोग गर्छ।
यो गाइडले तपाईंलाई सुरु गर्न सहयोग गर्नेछ।
आचार संहिता
सबै योगदानकर्ताले हाम्रो आचार संहिता पालना गर्नुपर्छ। सम्मानजनक हुनुहोस्। रचनात्मक हुनुहोस्। सद्भावना मान्नुहोस्।
छिटो सुरुवात
1. तपाईंलाई रुचि लाग्ने इस्यू खोज्नुहोस्
2. रिपोजिटरी फोर्क गर्नुहोस्
3. ब्रान्च बनाउनुहोस्
4. परिवर्तन गर्नुहोस्
5. pull request पेश गर्नुहोस्
6. समीक्षा प्रतिक्रियाको जवाफ दिनुहोस्
7. मर्ज हुनुहोस्। श्रेय पाउनुहोस्।
काम खोज्ने
सुरुवाती राम्रो इस्यू
कुनै पनि रिपोजिटरीमा good-first-issue लेबल भएका इस्यू हेर्नुहोस्। यी साना, स्पष्ट दायरा र निर्देशनसहितका कार्य हुन्।
सहयोग चाहिएको
help-wanted लेबल भएका इस्यूलाई योगदानकर्ता चाहिन्छ। ती ठूला वा विशेष सीप आवश्यक पर्ने हुन सक्छन्।
एक्सेलेरेटर कार्य
सीप प्रकार र अनुमानित प्रयासअनुसार व्यवस्थित क्युरेट गरिएका कार्यका लागि rv-accelerator रिपोजिटरी हेर्नुहोस्।
आफ्नै प्रस्ताव गर्नुहोस्
तपाईंले बनाउन चाहेको कुरा छुटेको देख्नुभयो भने, इस्यू खोली के गर्न चाहनुहुन्छ वर्णन गर्नुहोस्। हामी तपाईंसँग छलफल गर्नेछौं।
मानक योगदान कार्यप्रवाह
चरण १: फोर्क र क्लोन
GitHub मा रिपोजिटरी फोर्क गर्नुहोस्, त्यसपछि आफ्नो फोर्क स्थानीय रूपमा क्लोन गर्नुहोस्।
git clone https://github.com/YOUR-USERNAME/mountaineerfi-remote-valley-os.git
cd mountaineerfi-remote-valley-os
git remote add upstream https://github.com/FUMFGRP/mountaineerfi-remote-valley-os.git
चरण २: ब्रान्च बनाउनुहोस्
वर्णनात्मक नामको ब्रान्च बनाउनुहोस्।
git checkout -b feature/your-feature-name
# वा
git checkout -b fix/issue-number
# वा
git checkout -b docs/scope
चरण ३: परिवर्तन गर्नुहोस्
परिवर्तन गर्नुहोस्। विद्यमान कोड वा कागजातका परम्परा पछ्याउनुहोस्।
कोड परिवर्तनका लागि:
- विद्यमान शैली र ढाँचा पछ्याउनुहोस्
- जटिल तर्क अनिवार्य भए टिप्पणी समावेश गर्नुहोस्
- लागू भए परीक्षण लेख्नुहोस्
- तपाईंको परिवर्तनले प्रयोगलाई असर गर्छ भने कागजात अद्यावधिक गर्नुहोस्
कागजात परिवर्तनका लागि:
- एकरूप ढाँचासहित Markdown प्रयोग गर्नुहोस्
- भाषा सरल र सुलभ राख्नुहोस् (उच्च माध्यमिक अंग्रेजी स्तर)
- सहयोगी भए दृश्य सहायता समावेश गर्नुहोस् (आरेखण, स्क्रिनसट, फ्लोचार्ट)
- सक्नुभए अनुवाद थप्नुहोस्
चरण ४: कमिट
स्पष्ट कमिट सन्देश लेख्नुहोस्।
git add .
git commit -m "के परिवर्तन भयो भन्ने छोटो सारांश"
राम्रा कमिट सन्देश:
- “चिसोबाट बच्न सौर्य प्यानल कोण गणना थप”
- “५°C ले बिग्रिएको एक्सट्रुडर तापक्रम क्यालिब्रेसन सुधार”
- “पानी फिल्टर म्यानुअल नेपालीमा अनुवाद”
चरण ५: पुश गरी pull request खोल्नुहोस्
git push origin feature/your-feature-name
त्यसपछि GitHub मा मूल रिपोजिटरीको develop ब्रान्चविरुद्ध pull request खोल्नुहोस्।
चरण ६: PR विवरण
तपाईंको pull request विवरणमा समावेश गर्नुहोस्:
- तपाईंले के परिवर्तन गर्नुभयो
- किन गर्नुभयो (लागू भए इस्यूमा लिंक)
- कसरी परीक्षण गरियो (कोड वा हार्डवेयर परिवर्तनका लागि)
- सान्दर्भिक भए स्क्रिनसट वा आरेखण
- हेर्नुपर्ने ठान्नुभएका समीक्षकको @उल्लेख
चरण ७: समीक्षा
सबै pull request मर्ज हुनु अघि समीक्षा आवश्यक छ।
- समीक्षकको प्रतिक्रियाको जवाफ दिनुहोस्
- अनुरोध गरिएका परिवर्तन गर्नुहोस्
- धैर्य गर्नुहोस् — समीक्षक पनि स्वयंसेवक हुन्
- समीक्षा धेरै ढिलो भइरहेको भए, थ्रेडमा विनम्रतापूर्वक सम्झाउनुहोस्
चरण ८: मर्ज
स्वीकृत भएपछि, मर्मतकर्ताले तपाईंको PR मर्ज गर्नेछन्। अब तपाईं आधिकारिक योगदानकर्ता हुनुहुन्छ।
ब्रान्च रणनीति
| ब्रान्च | उद्देश्य | आधार ब्रान्च |
|---|---|---|
main | स्थिर रिलिज मात्र। संस्करण नम्बरले ट्याग। | — |
develop | हालको विकास चक्रको एकीकरण ब्रान्च। | — |
feature/* | नयाँ सुविधा। develop बाट बनाइन्छ। | develop |
fix/* | बग फिक्स। develop बाट बनाइन्छ। | develop |
docs/* | कागजात अद्यावधिक। develop बाट बनाइन्छ। | develop |
release/* | रिलिज तयारी ब्रान्च। | develop |
सधैं pull request develop विरुद्ध खोल्नुहोस्, main विरुद्ध होइन।
के मा काम गर्ने (रिपोजिटरीअनुसार)
| रिपोजिटरी प्रकार | के मा सहयोग चाहिन्छ |
|---|---|
| मोड्युल रिपो (rv-energy-microgrid, rv-waste-filament, आदि) | हार्डवेयर डिजाइन, BOM, फर्मवेयर, कागजात, अनुवाद |
| rv-os-core | API endpoint, सेन्सर संकलन, ड्यासबोर्ड घटक |
| rv-local-llm | तालिम डाटा तयारी, मोडेल क्वान्टाइजेसन, नेपाली भाषा डाटा |
| rv-education-pipeline | तालिम मोड्युल, मूल्यांकन, अनुवाद, चित्रण |
| rv-accelerator | कार्य क्युरेसन, योगदानकर्ता अनबोर्डिङ, कागजात |
| rv-adaptations | अनुकूलन टेम्प्लेट, क्षेत्रीय मूल्यांकन, केस स्टडी |
| rv-os-docs | समग्र कागजात गुणस्तर, क्रस-रेफरेन्स, एकरूपता |
फाइल नामकरण परम्परा
| फाइल प्रकार | परम्परा | उदाहरण |
|---|---|---|
| मोड्युल कागजात | docs/OPERATOR_MANUAL.md | docs/OPERATOR_MANUAL.md |
| तालिम मोड्युल | docs/TRAINING_MODULE.md | docs/TRAINING_MODULE.md |
| समस्या समाधान | docs/TROUBLESHOOTING.md | docs/TROUBLESHOOTING.md |
| अनुवाद | docs/translations/{भाषा-कोड}/ | docs/translations/ne/ |
| तस्बिर | assets/images/ | assets/images/extruder-diagram.png |
| हार्डवेयर डिजाइन | hardware/ | hardware/shredder-v2.step |
समीक्षा प्रक्रिया
| परिवर्तन प्रकार | आवश्यक समीक्षक | टिप्पणी |
|---|---|---|
| कागजात | १ मोड्युल मर्मतकर्ता | सरल परिवर्तनका लागि द्रुत-ट्र्याक |
| अनुवाद | १ मातृभाषी + १ मर्मतकर्ता | मातृभाषीले शुद्धता जाँच्छ |
| सफ्टवेयर / फर्मवेयर | १ मोड्युल मर्मतकर्ता | CI पास हुनुपर्छ |
| हार्डवेयर डिजाइन | २ मर्मतकर्ता | सुरक्षा-महत्त्वपूर्ण: थप समीक्षा आवश्यक |
| पाठ्यक्रम / मूल्यांकन | १ मास्टर ट्रेनर + १ मर्मतकर्ता | क्षेत्रमा प्रमाणित हुनुपर्छ |
| शासन / नीति | संस्था-व्यापी छलफल | कम्तीमा १४ दिन इस्यू खोल्ने |
सहयोग पाउने
- छलफल खोल्नुहोस्: github.com/FUMFGRP/mountaineerfi-remote-valley-os/discussions
- मर्मतकर्तालाई ट्याग गर्नुहोस्: इस्यूमा अड्किनुभए टिप्पणीमा सहयोग माग्नुहोस्
- इमेल: accelerator@mountaineer.fi
- मासिक सामुदायिक कल: प्रत्यक्ष भिडियो भेटमा सामेल हुनुहोस् — विवरण Discussions मा
मान्यता
हरेक योगदानकर्ता यहाँ श्रेय पाउँछन्:
- रिपोजिटरीको CHANGELOG.md
- संस्था-व्यापी CONTRIBUTORS.md
- रिलिज घोषणा र मासिक अद्यावधिक
हामी तपाईंको कामको उत्सव मनाउँछौं। तपाईं यो परियोजनाको भाग हुनुहुन्छ।
Remote Valley OS को भाग। खुला स्रोत हार्डवेयर र सफ्टवेयर इजाजतपत्र अन्तर्गत।