शैली नियम (साझा, लागू करने योग्य)

हाउस शैली एक जगह। “(test)” चिह्नित बिंदु tests/validate.py द्वारा लागू किए जाते हैं; उल्लंघन से बिल्ड विफल होता है। पूर्ण वर्णनात्मक संस्करण रिपॉज़िटरी की जड़ में spec/conventions.md है।

कठोर नियम

कोई एम-डैश नहीं। कभी ”—” (U+2014) का उपयोग न करें। कॉमा, कोलन, कोष्ठक या दो वाक्यों का उपयोग करें। एन-डैश ”–” केवल 1–9 या 2.1–2.8 जैसी संख्यात्मक श्रेणियों में अनुमत है। (test)
कोई घिसे-पिटे वाक्यांश नहीं। “not only … but also”, “but also” या “load-bearing” का उपयोग न करें। “It’s important to note”, “In today’s fast-paced world”, “It’s crucial to consider”, “It appears that”, “One could argue” और “it’s not just X, it’s Y” साँचे से बचें। (test, पहले तीन के लिए)
शब्दों को पहले उपयोग पर परिभाषित करें। हर विषय में पहली बार प्रयुक्त संक्षिप्त रूपों का विस्तार करें और पारिभाषिक शब्द परिभाषित करें, उदाहरण के लिए “mean time to recovery (MTTR)।”
मुख्य अवधारणाओं को विकिपीडिया से जोड़ें पहले उल्लेख पर, प्रति विषय एक बार, केवल गद्य में। रूप: [term](https://en.wikipedia.org/wiki/Article_Title)। कभी शीर्षकों, तालिकाओं, कोड या संदर्भ अनुभाग में नहीं। (लिंक का रूप एक test है)
केवल वास्तविक संदर्भ। वास्तविक कृतियों के लेखक और शीर्षक। कोई गढ़े हुए शीर्षक, लेखक या URL नहीं।
हेरफेर का रास्ता बताएँ। मेट्रिक परिवार का विषय बताता है कि मेट्रिक में कैसे हेरफेर होता है और कौन सा गार्डरेल उसे पकड़ता है (विषय 1.2)।

स्वर

गर्मजोशी भरा, सीधा, उत्साहवर्धक। पाठक को “आप” कहकर संबोधित करें। छोटे वाक्य, सरल शब्द। मुख्य बात से शुरू करें।
दृढ़ मत वाला और व्यावहारिक। विक्रेता-निरपेक्ष। उत्पादों के नाम केवल तथ्यात्मक उदाहरण के रूप में लें।

संरचना (test)

सामग्री विषय chapter-template.md में अनुभागों का सटीक क्रम उपयोग करते हैं।
पहला शीर्षक # N.M Title है (बिंदु-युक्त विषय क्रमांक), और यह फ़ाइल के शून्य-भरे PP-CC उपसर्ग से मेल खाता है।
हर भाग के भीतर क्रमांकन सतत है और N.0 से शुरू होता है।

संपादन के बाद

यदि आपने विषयों का समूह बदला, तो spec/structure.md अपडेट करें और just nav चलाएँ।
हमेशा just test चलाएँ।