فائل ناموں کے اصول

اگر آپ اپنے ADR عام ٹیکسٹ فائلوں میں بنانے کا انتخاب کرتے ہیں تو ہو سکتا ہے آپ ADR فائل کے ناموں کا اپنا اصول طے کرنا چاہیں۔

ہم فائل کے ناموں کا ایسا اصول استعمال کرنا پسند کرتے ہیں جس کی ایک مخصوص شکل ہو۔

مثالیں:

• choose-database.md

• format-timestamps.md

• manage-passwords.md

• handle-exceptions.md

ہمارا فائل ناموں کا اصول:

• نام میں حالِ حاضر کے حکمیہ (imperative) فعل پر مبنی جملہ ہوتا ہے۔ یہ پڑھنے میں آسانی دیتا ہے اور ہمارے کمٹ پیغام کی شکل سے ملتا ہے۔

• نام میں چھوٹے حروف اور ڈیش استعمال ہوتے ہیں (جیسا کہ اس ریپوزٹری میں)۔ یہ پڑھنے میں آسانی اور سسٹم کی قابلِ استعمالیت کے درمیان توازن ہے۔

• ایکسٹینشن markdown ہے۔ یہ آسان فارمیٹنگ کے لیے مفید ہو سکتی ہے۔