योगदान

इस पुस्तक को बेहतर बनाने में मदद के लिए धन्यवाद। हर आकार के योगदान का स्वागत है, वर्तनी की भूल सुधारने से लेकर नया विषय लिखने तक।

बुनियादी नियम

पुस्तक एक सख़्त हाउस शैली का पालन करती है। मूल बातें:

• कोई एम-डैश नहीं। कॉमा, कोलन, कोष्ठक या दो वाक्यों का उपयोग करें।
• कोई घिसे-पिटे वाक्यांश नहीं (“not only … but also”, “load-bearing” और इसी तरह के)।
• गर्मजोशी भरा, सरल, सीधा लेखन। पाठक को “आप” कहकर संबोधित करें। छोटे वाक्य।
• शब्दों को पहले उपयोग पर परिभाषित करें। मुख्य अवधारणाओं को पहले उल्लेख पर विकिपीडिया से जोड़ें।
• केवल वास्तविक संदर्भ।
• मेट्रिक परिवार का हर विषय अपने हेरफेर के रास्ते और अपने गार्डरेल का नाम बताता है।

पूरे नियम रिपॉज़िटरी की जड़ में spec/conventions.md में हैं, और संक्षिप्त संस्करण शैली नियम हैं। परीक्षण यांत्रिक हिस्सों को लागू करते हैं।

सेटअप

आपको Python 3 और just चाहिए। इस रिपॉज़िटरी में पुस्तक की सामग्री और विनिर्देश हैं, साथ ही SvelteKit साइट (software-engineering-metrics.github.io/) जो इसे प्रकाशित वेबसाइट में बदलती है।

just         # list tasks
just test    # run the validation suite
just nav     # regenerate the generated navigation files
just stats   # topic and word counts

बदलाव करना

1. प्रासंगिक मार्गदर्शिका पढ़ें: विषयों के लिए लेखन, उत्पन्न फ़ाइलों के लिए नेविगेशन, परीक्षणों के लिए परीक्षण।
2. काम करने वाला सबसे छोटा बदलाव करें।
3. यदि आपने कोई विषय जोड़ा, हटाया, नाम बदला या पुनः क्रमांकित किया, तो रिपॉज़िटरी की जड़ में spec/structure.md अपडेट करें और just nav चलाएँ।
4. just test चलाएँ। इसे पास होना चाहिए।
5. Unreleased के अंतर्गत परिवर्तन लॉग में एक पंक्ति की प्रविष्टि जोड़ें।

किस पर काम करें

• त्रुटियाँ, अस्पष्ट अंश या पुराने संदर्भ ठीक करें।
• उदाहरण बेहतर बनाएँ, विशेषकर ठोस उद्यम और सरकारी उदाहरण।
• वास्तविक स्रोतों के विरुद्ध उद्धरण जाँचें।
• टेम्पलेट तोड़े बिना किसी विषय के कवरेज की कमियाँ भरें।

किससे बचें

• उत्पन्न फ़ाइलें हाथ से संपादित न करें (README.md, हर लोकेल का index.md, front-matter/table-of-contents.md और topics/09-07-index.md)। इसके बजाय विषय बदलें और just nav चलाएँ।
• en-001, en-gb या en-us सीधे संपादित न करें; ये tools/localize.py द्वारा en-gb-oxendict से व्युत्पन्न हैं।
• spec/structure.md अपडेट किए बिना कोई विषय न जोड़ें।
• एम-डैश या प्रतिबंधित वाक्यांश न लाएँ; परीक्षण विफल हो जाएँगे।

समस्याओं की रिपोर्ट

समस्या, फ़ाइल और विषय, और जहाँ प्रासंगिक हो सही स्रोत या संदर्भ का वर्णन करते हुए एक इश्यू खोलें। छोटी, विशिष्ट रिपोर्टों पर कार्रवाई करना सबसे आसान है।