Changelog Template

A software project changelog template following Keep a Changelog conventions.

# Changelog Template: سافٹ ویئر پروجیکٹ کی دستاویزی کاری کے لیے ضروری ٹول کٹ سافٹ ویئر پروجیکٹ کو برقرار رکھنے کا مطلب صرف کوڈ لکھنا نہیں ہے؛ بلکہ اپنے کام کے ارتقاء کو اپنے صارفین، تعاون کرنے والوں، اور اپنے مستقبل کے لیے بیان کرنا ہے۔ اس کے باوجود، بہت سے ڈویلپرز کے لیے، CHANGELOG.md فائل کو اپ ڈیٹ کرنے کا کام اکثر نظر انداز کر دیا جاتا ہے یا ریلیز کے ہنگامے میں بالکل بھول جاتا ہے۔ "Changelog Template" ایک کروم ایکسٹینشن ہے جسے اس خلا کو پُر کرنے کے لیے ڈیزائن کیا گیا ہے، جو انڈسٹری کے معیاری کنونشنز کے مطابق اعلیٰ معیار کے چینج لاگز کو برقرار رکھنے کے لیے ایک منظم، بدیہی اور پیشہ ورانہ ورک فلو فراہم کرتی ہے۔ ## بنیادی مقصد: "Keep a Changelog" کے ذریعے بہتر مواصلت اس کے مرکز میں، Changelog Template کو "Keep a Changelog" کنونشنز کی پیروی کرنے میں سافٹ ویئر پروجیکٹس کی مدد کرنے کے لیے بنایا گیا ہے۔ ایک اچھا چینج لاگ ہر پروجیکٹ ورژن کے لیے نمایاں تبدیلیوں کی ایک ترتیب وار فہرست ہے۔ یہ گٹ کمٹس کا خام ڈیٹا نہیں ہے؛ یہ انسانوں کے لیے لکھی گئی ایک دستاویز ہے۔ اس ایکسٹینشن کا استعمال کرتے ہوئے، آپ اس بات کو یقینی بناتے ہیں کہ آپ کے پروجیکٹ کی تاریخ پڑھنے کے قابل، منظم، اور مفید ہو۔ چاہے آپ ایک چھوٹا سائیڈ پروجیکٹ چلا رہے ہوں، بڑی اوپن سورس لائبریری، یا داخلی ٹولز کا مجموعہ، Changelog Template آپ کو اپنے ڈویلپمنٹ سائیکل میں رکاوٹ پیدا کیے بغیر شفافیت اور پیشہ ورانہ مہارت کو برقرار رکھنے کے لیے درکار ڈھانچہ فراہم کرتا ہے۔ ## ایک معیاری فارمیٹ جس پر آپ بھروسہ کر سکتے ہیں یہ ایکسٹینشن سختی سے معیاری چینج لاگ فارمیٹ کے ساتھ مطابقت رکھتی ہے، اس بات کو یقینی بناتے ہوئے کہ آپ کی دستاویزات پیشہ ورانہ نظر آئیں اور وسیع تر ایکو سسٹم کے ساتھ مطابقت رکھیں۔ آپ کی بنائی ہوئی ہر اندراج کو "Keep a Changelog" پروجیکٹ کی تجویز کردہ چھ معیاری تبدیلی کی اقسام میں سے ایک میں درجہ بندی کیا گیا ہے: 1. **Added (شامل کیا گیا):** نئی خصوصیات کے لیے جو آپ کے سافٹ ویئر کی صلاحیتوں کو بڑھاتی ہیں۔ 2. **Changed (تبدیل کیا گیا):** موجودہ فعالیت میں تبدیلیوں کے لیے جو کام کرنے کے طریقے کو بدلتی ہیں۔ 3. **Deprecated (متروک):** جلد ہٹائی جانے والی خصوصیات کے لیے، صارفین کو مائیگریٹ کرنے کے لیے الرٹ دینے کے لیے۔ 4. **Removed (ہٹایا گیا):** ان خصوصیات کے لیے جنہیں باضابطہ طور پر کوڈ بیس سے ہٹا دیا گیا ہے۔ 5. **Fixed (درست کیا گیا):** کسی بھی بگ فکس کے لیے جو مسائل کو حل کرتا ہے اور استحکام کو بہتر بناتا ہے۔ 6. **Security (سیکیورٹی):** خطرات کو دور کرنے کے لیے اہم پیچز کے لیے۔ یہ درجہ بندی صارفین کو آپ کے ریلیز نوٹس کو تیزی سے اسکین کرنے میں مدد کرتی ہے تاکہ وہ بالکل وہی تلاش کر سکیں جس کی انہیں ضرورت ہے، چاہے وہ نئے ٹولز کی تلاش میں ہوں یا یہ چیک کر رہے ہوں کہ آیا کوئی مخصوص بگ حل ہو گیا ہے۔ ## مؤثر اندراجات لکھنے پر رہنمائی ایک اچھا چینج لاگ اندراج لکھنا ایک فن ہے۔ اس کے لیے تکنیکی درستگی اور رسائی کے درمیان توازن کی ضرورت ہوتی ہے۔ Changelog Template آپ کو صرف ایک ٹیکسٹ باکس نہیں دیتا؛ یہ سیاق و سباق اور رہنمائی فراہم کرتا ہے جو اہم اندراجات لکھنے کے لیے ضروری ہے۔ ہم تین سادہ اصولوں کی وکالت کرتے ہیں: - **سنگل جملے استعمال کریں:** اسے مختصر رکھیں۔ فی اندراج ایک واضح نقطہ گھنے پیراگراف سے بہتر ہے۔ - **ماضی کا زمانہ (Past Tense) استعمال کریں:** آپ بیان کر رہے ہیں کہ *کیا تبدیل ہوا ہے* (مثلاً، "تلاش کی کارکردگی بہتر کی گئی" کے بجائے "تلاش کی کارکردگی بہتر کریں")۔ - **صارف کے نقطہ نظر کو اپنائیں:** اس شخص کے لیے لکھیں جو آپ کا سافٹ ویئر استعمال کر رہا ہے، نہ کہ اس کے لیے جس نے کوڈ لکھا ہے۔ "SQL کوئری آپٹیمائزر کو ری فیکٹر کیا گیا" کہنے کے بجائے، کہیں "تلاش کی کارکردگی میں 50 فیصد بہتری آئی۔" ایکسٹینشن خود بخود آپ کے اندراجات کو کیپیٹلائز کرنے اور یہ یقینی بنانے میں مدد کرتی ہے کہ اگر آپ بھول جائیں تو وہ مناسب وقفے (period) پر ختم ہوں۔ ## فیچر سے بھرپور ورک اسپیس Changelog Template ان خصوصیات سے بھرا ہوا ہے جو دستاویزی کاری کو آپ کے ورک فلو کا ایک قدرتی حصہ بناتی ہیں: ### 1. فوری اندراج کی تخلیق "Create" ٹیب آپ کا لینڈنگ زون ہے۔ اپنی تبدیلی کی قسم منتخب کریں، اپنا اندراج ٹائپ کریں، اور "Add to Unreleased" پر کلک کریں۔ یہ اتنا ہی آسان ہے۔ اب فوری اپ ڈیٹ نوٹ کرنے کے لیے اپنے IDE اور مارک ڈاؤن فائل کے درمیان سوئچ کرنے کی ضرورت نہیں۔ ### 2. مستقل "Unreleased" انتظام اچھے چینج لاگ کی سب سے طاقتور خصوصیات میں سے ایک "Unreleased" سیکشن ہے۔ یہ ان تمام تبدیلیوں کے لیے ایک اسٹیجنگ ایریا کے طور پر کام کرتا ہے جو آپ نے آخری سرکاری ورژن کے بعد سے کی ہیں۔ Changelog Template اس سیکشن کو آپ کے لیے منظم کرتا ہے، آپ کے اندراجات کو لوکل اسٹوریج میں محفوظ رکھتا ہے تاکہ جب بھی آپ ایکسٹینشن کھولیں تو وہ تیار رہیں۔ ### 3. سیمنٹک ورژننگ (SemVer) حوالہ ورژننگ کا اندازہ لگانے کا کھیل نہیں ہونا چاہیے۔ ہمارا "Reference" ٹیب سیمنٹک ورژننگ (SemVer) کے لیے ایک کوئیک اسٹارٹ گائیڈ شامل کرتا ہے، جو آپ کو یہ فیصلہ کرنے میں مدد کرتا ہے کہ آیا آپ کی اگلی ریلیز میجر، مائنر، یا پیچ ورژن ہونی چاہیے: - **MAJOR (میجر):** غیر مطابقت پذیر API تبدیلیوں کے لیے۔ - **MINOR (مائنر):** بیک ورڈز-مطابقت پذیر انداز میں فعالیت شامل کرنے کے لیے۔ - **PATCH (پیچ):** بیک ورڈز-مطابقت پذیر بگ فکسز کے لیے۔ ### 4. آٹومیشن ٹولز کا حوالہ ان ٹیموں کے لیے جو اگلے قدم کے لیے تیار ہیں، ہم صنعت کے معیاری آٹومیشن ٹولز جیسے `standard-version`، `release-it`، اور `semantic-release` کی طرف اشارہ فراہم کرتے ہیں۔ یہ ٹولز ہماری ایکسٹینشن کے ذریعے تیار کردہ مارک ڈاؤن فارمیٹ کے ساتھ مل کر کام کرتے ہیں تاکہ آپ کے پورے ریلیز کے عمل کو خودکار بنایا جا سکے۔ ### 5. ایک کلک پر کاپی اور مارک ڈاؤن ایکسپورٹ ایک بار جب آپ اپنی فائل کو اپ ڈیٹ کرنے کے لیے تیار ہو جائیں، تو آپ "Unreleased" سیکشن کو ایک کلک کے ساتھ فارمیٹ شدہ مارک ڈاؤن کے طور پر کاپی کر سکتے ہیں۔ ایک نیا پروجیکٹ شروع کرنے کی ضرورت ہے؟ ایک مکمل، بوائلر پلیٹ فائل بنانے کے لیے ہمارے "Full CHANGELOG.md Starter Template" کا استعمال کریں جس میں ضروری ہیڈرز اور لنکس شامل ہیں۔ ## ایک اچھا چینج لاگ کیوں اہمیت رکھتا ہے ایک اچھی طرح سے برقرار رکھا گیا چینج لاگ اپ ڈیٹس کی فہرست سے کہیں زیادہ ہے؛ یہ ایک صحت مند، پختہ پروجیکٹ کی علامت ہے۔ یہ **شفافیت** کو ظاہر کرتا ہے کہ پروجیکٹ فعال طور پر برقرار رکھا جا رہا ہے۔ یہ **مواصلات** میں سہولت فراہم کرتا ہے ان اہم تبدیلیوں کو نمایاں کرکے جو بصورت دیگر سیکڑوں کمٹ پیغامات میں دفن ہو سکتی ہیں۔ سب سے بڑھ کر، یہ **پیشہ ورانہ مہارت** کا مظاہرہ کرتا ہے۔ جب صارف ایک صاف ستھرا، منظم CHANGELOG.md دیکھتا ہے، تو وہ جانتا ہے کہ وہ پروجیکٹ اور اس کے پیچھے موجود ڈویلپر پر بھروسہ کر سکتا ہے۔ ## یہ کن کے لیے ہے؟ - **سولو ڈویلپرز:** اپنے سائیڈ پروجیکٹس کو منظم رکھیں اور "میں نے تین ماہ پہلے کیا کیا تھا؟" والے لمحے سے بچیں۔ - **چھوٹی ٹیمیں:** اس بات کو یقینی بنائیں کہ ہر کوئی پروجیکٹ کی پیشرفت کے بارے میں ایک ہی صفحے پر ہے بغیر ہر چھوٹی اپ ڈیٹ کے لیے پیچیدہ جیرا بورڈز کی ضرورت کے۔ - **اوپن سورس تعاون کرنے والے:** اپنے پروجیکٹ کو نئے صارفین کے لیے زیادہ پرکشش بنائیں، واضح اور پڑھنے میں آسان ریلیز نوٹس فراہم کر کے۔ ## استعمال میں آسانی: کوئی سیٹ اپ نہیں، کوئی پریشانی نہیں Changelog Template کو اس طرح ڈیزائن کیا گیا ہے کہ جب تک آپ کو اس کی ضرورت نہ ہو یہ پوشیدہ رہے۔ کوئی پیچیدہ سیٹ اپ نہیں ہے، بنانے کے لیے کوئی بیرونی اکاؤنٹس نہیں ہیں، اور انتظام کرنے کے لیے کوئی API کیز نہیں ہیں۔ یہ آپ کے ڈیٹا کو نجی رکھنے اور صرف آپ کی مشین پر قابل رسائی بنانے کے لیے کروم کی لوکل اسٹوریج کا استعمال کرتا ہے۔ UI کم سے کم اور ریسپانسیو ہے، جو آپ کے براؤزر کی سائڈبار یا پاپ اپ ایریا میں بالکل فٹ بیٹھتا ہے۔ اپنی پروجیکٹ کی دستاویزی کاری کو پیچھے نہ رہنے دیں۔ آج ہی **Changelog Template** کا استعمال شروع کریں اور اپنے سافٹ ویئر کو وہ پیشہ ورانہ تاریخ دیں جس کا وہ مستحق ہے۔