योगदान

जब आप Evey के कोड पर काम करना चाहें, तो कहाँ से शुरू करें, और pull request को कौन सी जाँचें पास करनी चाहिए। योगदान करने वालों के लिए लिखे दस्तावेज़ इस साइट पर नहीं, कोड के साथ GitHub पर रखे गए हैं; यह पेज उनकी ओर इशारा करता है।

कहाँ से शुरू करें

आप चाहते हैं	पढ़ें
Evey को स्रोत से build करके चलाना	DEV.md
योगदान के नियम जानना: branch, commit, टेस्ट, लाइसेंस समझौता	CONTRIBUTING.md
आधे घंटे में कोड की संरचना समझना	कोड का नक्शा
परतों और bounded context को समझना	आर्किटेक्चर
उन तौर-तरीकों का पालन करना जो कोड पहले से इस्तेमाल करता है	कोड के तौर-तरीके
इंटरफ़ेस पर काम करना	फ़्रंटएंड डिज़ाइन सिस्टम
जानना कि कोई ढाँचे वाला फ़ैसला क्यों लिया गया	आर्किटेक्चर के फ़ैसले
रिलीज़ निकालना	रिलीज़ रनबुक

फ़ैसले का रिकॉर्ड क्यों, और कहाँ

हर ढाँचे वाले फ़ैसले का - hexagonal बनावट, प्लगइन token का दायरा कैसे तय होता है, इंस्टॉल एक ही compose फ़ाइल क्यों है, एक प्लेबैक योजना हर क्लाइंट के लिए कैसे तय करती है - एक architecture decision record होता है: संदर्भ, तौले गए विकल्प, क्या चुना गया और उसकी कमियाँ क्या हैं। ये repository में, उसी कोड के बगल में रखे जाते हैं जिसे ये समझाते हैं, और इनमें से किसी फ़ैसले को बदलने का प्रस्ताव देने से पहले शुरुआत यहीं से करनी चाहिए।

pull request खोलने से पहले

1. make pre-push चलाएँ: यही gate है, और यह CI की जाँचें लोकल रूप से इस क्रम में चलाता है: vet, कमज़ोरियों की जाँच, build, -race के साथ unit टेस्ट, फ़्रंटएंड (typecheck, lint, unit टेस्ट), सुरक्षा जाँच, lint, आर्किटेक्चर की जाँचें, commit के नियमों की जाँच, secret की जाँच, proto में breaking change की जाँच, साफ़ checkout से build, repository और ट्रांसकोडिंग के integration gate, और TV audit।
2. नए बर्ताव के लिए और हर bug fix के लिए टेस्ट जोड़ें।
3. बाहर से योगदान के लिए, एक बार योगदानकर्ता लाइसेंस समझौता स्वीकार करें: Evey AGPL-3.0-or-later है और इसे एक व्यावसायिक लाइसेंस के तहत भी दिया जा सकता है। आपके काम का copyright आपके पास ही रहता है।

gate न Docker इमेज बनाता है, न Android ऐप

Dockerfile या Kotlin कोड छूने के बाद, push करने से पहले इन्हें खुद build करें (docker build --target runtime, Gradle का release task)।

सुरक्षा की समस्याएँ सार्वजनिक रूप से नहीं बताई जातीं: security@eveyproject.org पर लिखें (देखें SECURITY.md)।