اسلوب کے اصول (مشترکہ، قابلِ نفاذ)

ہاؤس اسٹائل ایک جگہ۔ جن نکات پر “(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)۔ کبھی عنوانات، جدولوں، کوڈ، یا حوالہ جات کے حصے میں نہیں۔ (لنک کی شکل ٹیسٹ ہے)
صرف حقیقی حوالہ جات۔ حقیقی تصانیف کے مصنفین اور عنوانات۔ گھڑے ہوئے عنوانات، مصنفین، یا URL نہیں۔
ہیرا پھیری کی راہ کا نام لیں۔ میٹرکس کے خاندان کے موضوعات بتاتے ہیں کہ میٹرک میں کیسے ہیرا پھیری ہوتی ہے اور کون سی حفاظتی حد اسے پکڑتی ہے (موضوع 1.2)۔

آواز

گرمجوش، براہِ راست، حوصلہ افزا۔ قاری سے براہِ راست مخاطب ہوں۔ مختصر جملے، سادہ الفاظ۔ اصل بات سے شروع کریں۔
دو ٹوک اور عملی۔ فروخت کنندہ سے غیر جانبدار۔ مصنوعات کا ذکر صرف حقائق پر مبنی مثالوں کے طور پر کریں۔

ڈھانچہ (test)

مواد کے موضوعات chapter-template.md میں حصوں کی ترتیب بالکل وہی استعمال کرتے ہیں۔
پہلا عنوان # N.M Title ہے (نقطے والا موضوع نمبر) اور فائل کے صفر سے بھرے PP-CC سابقے سے ملتا ہے۔
ہر حصے کے اندر نمبرنگ مسلسل ہے اور N.0 سے شروع ہوتی ہے۔

ترمیم کے بعد

اگر آپ نے موضوعات کا سیٹ بدلا ہے تو spec/structure.md اپ ڈیٹ کریں اور just nav چلائیں۔
ہمیشہ just test چلائیں۔