GitHub پر اپنے پروجیکٹس کے ساتھ کام کو بہتر بنانا: Github Template Repository سے واقفیت

سب کو ہیلو، JavaRush کمیونٹی! آج ہم اوپن سورس کے بارے میں بات کریں گے اور لکھے گئے کوڈ کے علاوہ ایک اعلیٰ معیار کے پروجیکٹ کو بنانے کے لیے کیا کرنا پڑتا ہے ۔ مفید پروڈکٹ لکھنا ضروری ہے۔ لیکن ذخیرے کا صحیح ڈیزائن کم اہم نہیں ہے (گٹ ہب پر پروجیکٹ ریپوزٹری)۔ اس سے ایک اور اہم نکتہ یعنی پروڈکٹ کو فروغ دینے میں مدد ملے گی۔ یہاں تک کہ اگر پروجیکٹ بہت اچھا ہے، لیکن اگر یہ خراب ڈیزائن کیا گیا ہے، کم از کم README میں بیان نہیں کیا گیا ہے (آپ یہاں پڑھ سکتے ہیں کہ README کیا ہے )، لائسنس کی نشاندہی نہیں کی گئی ہے، وغیرہ، وغیرہ، وہاں ہوگا کوئی کامیابی نہیں. یہ صرف اتنا ہے کہ کوئی اسے نوٹس نہیں کرے گا۔ اور اگر کوئی نوٹس لے، تو وہ نہیں جانیں گے کہ اس کے ساتھ بات چیت کیسے کی جائے۔ بہت ساری چیزیں ہیں جنہیں بار بار پُر کرنے کی ضرورت ہے، اور پروگرامر کے لیے ہر بار کاپی اور پیسٹ کرنا آسان نہیں ہے، اور صرف اس کے لیے، اس موسم گرما میں، GitHub نے ٹیمپلیٹ ریپوزٹری فیچر جاری کیا جو اس میں مدد کرتا ہے۔ تو بات کرنے کے لیے، نئے پروجیکٹس بنانے کے عمل کو خودکار بنانا۔ آج ہم سمجھیں گے کہ Repository کیا ہوتی ہے اور Template Repository کیا ہوتی ہے۔ ہم بیان کریں گے کہ کوڈ کے علاوہ پروجیکٹ میں کیا ہونا چاہیے، آپ کو کن چیزوں پر توجہ مرکوز کرنے کی ضرورت ہے۔ آئیے شروع سے ایک ٹیمپلیٹ ریپوزٹری بنائیں اور میرے نقطہ نظر سے ضروری ہر چیز کو شامل کریں۔ اور آخر میں، ہم ایک نیا ذخیرہ بناتے وقت ٹیمپلیٹ ریپوزٹری کا استعمال کریں گے۔ لیکن پہلے، آئیے شرائط کو سمجھیں۔ تھیوری: کسی بھی پروجیکٹ کے عمومی ذخیرے میں کیا ہونا چاہیے GitHub پر ہر اوپن سورس پروجیکٹ کا ایک اچھی طرح سے بیان کردہ کمیونٹی پروفائل ہونا چاہیے ، جس میں درج ذیل عناصر ہوتے ہیں۔

1. ایشو ٹیمپلیٹ

یہاں آپ کو ذخیرہ میں ایک مسئلہ پیدا کرنے کے قواعد کی وضاحت کرنے کی ضرورت ہے: انہیں کیا بلایا جانا چاہئے، لیبل کیا ہوگا، اسے کس کو تفویض کیا جائے گا۔ نیا شمارہ بناتے وقت، درج ذیل اختیارات پیش کیے جائیں گے:

• بگ رپورٹ - پروجیکٹ میں خرابی کو بیان کرنے کے لیے مسئلہ پیدا کرنا؛
• خصوصیت کی درخواست - ایک منصوبے کے لئے ایک نئے خیال کی تجویز؛
• بہتری کی درخواست - منصوبے میں بہتری کی تجویز؛
• حسب ضرورت ایشو ٹیمپلیٹ - اگر دوسرے آپشنز کام نہیں کرتے ہیں، تو آپ خالی ٹیمپلیٹ استعمال کر سکتے ہیں۔

یہ کیسا لگتا ہے اس کی ایک مثال یہاں دیکھی جا سکتی ہے ۔

2. لائسنس

لائسنس جس کے تحت پروجیکٹ لکھا جاتا ہے۔ یہ ضروری ہے کہ جو لوگ اس منصوبے کو استعمال کریں گے وہ جان لیں کہ کس چیز کی ضمانت ہے اور کیا نہیں۔ مثال کے طور پر، اپاچی لائسنس 2.0 درج ذیل کہتا ہے:

3.README

یہ پروجیکٹ کی تفصیل ہے، اس کا کالنگ کارڈ۔ اس منصوبے کے بارے میں جو کچھ کہنے کی ضرورت ہے وہ یہاں ہونی چاہیے۔ بلاشبہ، ہر بار پروجیکٹ کی تفصیلات کو مدنظر رکھتے ہوئے اسے بیان کرنے کی ضرورت ہوگی، لیکن عنوانات ایک جیسے ہوں گے۔ مثال کے طور پر:

• جائزہ - منصوبے کی ایک مختصر وضاحت؛
• استعمال - منصوبے کو استعمال کرنے کا طریقہ؛
• عمارت - ایک منصوبے کو کیسے شروع کرنا ہے، اس کے لئے کیا ضرورت ہے؛
• ٹربل شوٹنگ - یہ بتاتا ہے کہ آپ کو کن مسائل کا سامنا کرنا پڑ سکتا ہے اور انہیں کیسے حل کیا جائے؛
• ریلیز نوٹس - ورژن پر منحصر تبدیلیوں کی تفصیل؛
• مصنفین - اپنے پیاروں کے بارے میں مت بھولنا؛
• تعاون کرنا - آپ اس منصوبے کی ترقی میں کس طرح حصہ لے سکتے ہیں اس کی وضاحت؛
• ضابطہ اخلاق - شرکت کے قواعد کی وضاحت؛
• RELEASE_NOTES - ایک فائل جس میں نئے ورژن کی تمام تبدیلیاں ریکارڈ کی جاتی ہیں۔ اسے ایک علیحدہ دستاویز میں رکھنا اور README میں ایک لنک محفوظ کرنا ایک اچھا عمل ہے۔
• CONTRIBUTING ایک فائل ہے جو بیان کرتی ہے کہ آپ اس پروجیکٹ کی ترقی میں کس طرح اپنا حصہ ڈال سکتے ہیں۔ README میں تعاون کرنے والے ہیڈر کے لیے علیحدہ فائل کے طور پر بنایا گیا ہے۔
• CODE_OF_CONDUCT - ایک فائل جو پروجیکٹ کی ترقی میں حصہ لینے کے قواعد کو بیان کرتی ہے۔
• پل ریکوئسٹ ٹیمپلیٹ - ان لوگوں کے لیے ایک ٹیمپلیٹ جو پل کی درخواست بنائیں گے۔

پروگرامنگ زبان یا اس کی تفصیلات سے قطع نظر یہ تمام چیزیں پروجیکٹ سے دوسرے پروجیکٹ میں استعمال ہوتی ہیں۔

مشق: اپنا ٹیمپلیٹ بنانا

جیسا کہ وہ کہتے ہیں، آئیے الفاظ سے عمل کی طرف بڑھیں۔ اب، ایک مثال کا استعمال کرتے ہوئے، میں آپ کو دکھاؤں گا کہ آپ اپنا ٹیمپلیٹ کیسے بنائیں۔

1. پہلی چیز جس کی آپ کو ضرورت ہے وہ ہے GitHub پر ایک اکاؤنٹ / وہاں رجسٹر کریں ۔

2. ایک نیا ذخیرہ بنائیں: ایسا کرنے کے لیے، اوپری دائیں کونے میں + پر کلک کریں۔

3. تخلیق کرتے وقت، بھریں:

   • ریپوزٹری کا نام - میرے کیس میں ریپوزٹری ٹیمپلیٹ؛
   • تفصیل - منصوبے کی مختصر وضاحت؛
   • ہم عوامی چھوڑ دیتے ہیں، حالانکہ آپ پرائیویٹ منتخب کر سکتے ہیں۔
   • README شروع کرنے والے باکس کو چیک کریں:

   • اس لائسنس کو منتخب کریں جس کے تحت پروجیکٹ ہو گا:

     چونکہ میرے معاملے میں ٹیمپلیٹ عام ہے، gitignore کی ضرورت نہیں ہے: اسے ایک مخصوص پروجیکٹ اور پروگرامنگ زبان کے لیے شامل کیا جائے گا۔

     لہذا، Repository تخلیق کریں پر کلک کریں ، اس طرح تخلیق کا عمل مکمل ہوتا ہے۔ نظام خود بخود ہمیں نئے بنائے گئے ذخیرہ میں لے جائے گا۔

4. کمیونٹی پروفائل کو پُر کرنا : بنائے گئے ریپوزٹری میں، بصیرت کے ٹیب پر جائیں اور Community کو منتخب کریں :

   جیسا کہ آپ دیکھ سکتے ہیں، جو کچھ باقی ہے وہ کوڈ آف کنڈوسی، کنٹریبیوٹنگ، ایشو ٹیمپلیٹ، پل ریکوسٹ ٹیمپلیٹ کو پُر کرنا ہے۔

   ضابطہ اخلاق کی مثال استعمال کرتے ہوئے، ہم دکھائیں گے کہ انہیں کسی پروجیکٹ میں کیسے شامل کیا جائے۔

   Add پر کلک کریں ، سسٹم آپ کو Contributor Covenant یا Citizen Code of Conduct منتخب کرنے کا اشارہ کرتا ہے :

   میں پہلا منتخب کرتا ہوں اور Review اور Submit پر کلک کرتا ہوں ۔

   اگلا، آپ اس فائل میں ترمیم کر کے اس کا ارتکاب کر سکتے ہیں۔

   نیچے، کمٹ براہ راست ماسٹر برانچ کے آپشن کو منتخب کریں اور نئی فائل پر کلک کریں :

   نتیجے کے طور پر، اگر ہم کمیونٹی پروفائل پر واپس جاتے ہیں ، تو ہم دیکھیں گے کہ ضابطہ اخلاق کو شامل کیا گیا ہے:

   تعاون اور ایشو ٹیمپلیٹ کو اسی طرح شامل کیا گیا ہے، اس لیے میں اسے نہیں دکھاؤں گا۔ اسے اپنے آپ کو ؛)

5. پل درخواست ٹیمپلیٹ شامل کریں ۔

   لیکن ہم اس کے بارے میں الگ سے بات کریں گے۔

   مجھے نہیں معلوم کہ GitHub نے Pull-Request ٹیمپلیٹ کو ترتیب دینے کے لیے وہی آسان آپشن کیوں شامل نہیں کیا ہے، لہذا آپ کو دستاویزات کا مطالعہ کرکے اسے دستی طور پر شامل کرنا ہوگا۔

   ایسا کرنے کے لیے، ریپوزٹری کے روٹ میں نئی ​​فائل بنائیں پر کلک کریں :

   فائل کا نام ہونا چاہئے: .github/pull_request_template.md ۔

   ہم ٹیمپلیٹ میں اپنی ضرورت کو شامل کرتے ہیں اور Commit new file پر کلک کرتے ہیں ، جیسا کہ ہم نے اوپر کیا تھا۔ میں وہیل کو دوبارہ ایجاد کرنے نہیں جا رہا تھا اور مجھے ایک ایسی مثال ملی جو میرے لیے کافی قابل استعمال معلوم ہوئی۔

   اس طرح پورا کمیونٹی پروفائل پُر ہو جائے گا:

6. ایک ٹیمپلیٹ ریپوزٹری مارکر شامل کریں ۔

   ایسا کرنے کے لیے ریپوزٹری میں سیٹنگز آپشن پر جائیں اور اس باکس کو چیک کریں جہاں یہ کہتا ہے Template Repository:

   اور بس، نئے پروجیکٹس بنانے کا سانچہ تیار ہے۔ اس طرح، ہم مستقبل میں بہت زیادہ وقت بچائیں گے جب ہمیں نئے پروجیکٹس بنانے کی ضرورت ہوگی۔ اس سے آپ کو اہم تفصیلات سے محروم نہ ہونے میں بھی مدد ملے گی، کیونکہ اکثر ایسا ہوتا ہے کہ آپ کچھ شامل کرنا بھول جاتے ہیں، مثال کے طور پر، لائسنس یا کسی مسئلے کے لیے واضح ٹیمپلیٹ۔

ٹیمپلیٹ ریپوزٹری کا استعمال کیسے کریں۔

استعمال کے لیے دو اختیارات ہیں:

1. جب ایک ٹیمپلیٹ براہ راست آپ کی ملکیت میں ہوتا ہے: نیا ذخیرہ بناتے وقت، آپ کو ٹیمپلیٹ کی فہرست میں سے ٹیمپلیٹ سے تخلیق کرنے کا اختیار دیا جائے گا:

2. جب ٹیمپلیٹ غیر ملکی ہے: یہاں بھی کوئی خاص مسئلہ نہیں ہے۔ اس ٹیمپلیٹ پر جائیں اور اس ٹیمپلیٹ کا استعمال کریں بٹن پر کلک کریں ۔ یہاں میں سرکاری دستاویز سے اینیمیشن استعمال کروں گا:

آئیے اس کا خلاصہ کرتے ہیں۔

اس مضمون میں ہم نے دیکھا:

• GitHub ذخیرہ کیا ہے؛
• ٹیمپلیٹ ریپوزٹری کیا ہے
• ٹیمپلیٹ ریپوزٹری میں کیا ہونا چاہیے؛
• ٹیمپلیٹ ریپوزٹری کیسے بنائیں؛
• ٹیمپلیٹ ریپوزٹری کا استعمال کیسے کریں۔

بلاشبہ، اس ٹیمپلیٹ کی بنیاد پر، آپ پہلے سے ہی زیادہ مخصوص بنا سکتے ہیں۔ مثال کے طور پر، میں نے پہلے سے تشکیل شدہ ماون یا گریڈل بلڈ سسٹم کے ساتھ مزید ٹیمپلیٹس بنائے ہیں ۔ مزید: آپ آخری دو کی بنیاد پر اسپرنگ بوٹ ریپوزٹری ٹیمپلیٹ بنا سکتے ہیں۔ تمام ٹیمپلیٹس کو گروپ کرنے کے لیے، میں نے تمام ٹیمپلیٹس کے ساتھ گٹ ہب پر ایک ٹیمپلیٹ ریپوزٹری تنظیم بنائی۔ میرے GitHub اکاؤنٹ کو سبسکرائب کریں۔

مفید لنکس

• میرے بنائے ہوئے تمام ٹیمپلیٹس کے ساتھ تنظیم
• GitHub بلاگ: ریپوزٹری ٹیمپلیٹس کے ساتھ نیا ریپوزٹری بنائیں ریپوزٹریز کے لیے ٹیمپلیٹ کیسے بنایا جائے
• GitHub ہیلپ: ریپوزٹریز کے بارے میں کہ ریپوزٹریز کیا ہیں۔
• گٹ ہب ہیلپ: ٹیمپلیٹ سے ریپوزٹری بنانا ٹیمپلیٹ کی بنیاد پر نیا پروجیکٹ کیسے بنایا جائے
• GitHub ہیلپ: پروجیکٹس کے لیے لائسنسنگ کے ذخیرے کی تفصیل کو لائسنس دینا
• GitHub مدد: ایک ذخیرہ بنانے کی ایک ریپو تفصیل بنائیں
• اوپن سورس پراجیکٹس بنانے/بیان کرنے کے لیے اوپن سورس گائیڈز کی تجاویز۔
• GitHub ہیلپ: پل ریکوئسٹ ٹیمپلیٹ شامل کرنا - پل کی درخواستوں کے لیے ٹیمپلیٹ بنانا۔

میرے مزید مضامین

• Intellij IDEA میں ڈیبگ: ابتدائیوں کے لیے ایک گائیڈ
• Skyscanner API کے لیے کلائنٹ بنانے اور اسے jCenter اور Maven Central میں شائع کرنے کے لیے گائیڈ [حصہ 1]
• Skyscanner API کے لیے کلائنٹ بنانے اور اسے jCenter اور Maven Central میں شائع کرنے کے لیے گائیڈ [حصہ 2]
• ہوائی ٹکٹ کی قیمت کی نگرانی کا نظام بنانا: مرحلہ وار گائیڈ [حصہ 1]
• ہوائی ٹکٹ کی قیمت کی نگرانی کا نظام بنانا: مرحلہ وار گائیڈ [حصہ 2]
• ہوائی ٹکٹ کی قیمت کی نگرانی کا نظام بنانا: مرحلہ وار گائیڈ [حصہ 3]
• لاگنگ: کیا، کیسے، کہاں اور کس کے ساتھ؟
• انٹرویو کا ٹیسٹ اوپن سورس لائبریری میں کیسے تبدیل ہوا۔
• کامیابی کی تاریخ۔ فی ہفتہ 20 گھنٹے پروگرامنگ، ماسٹر ڈگری اور ذاتی زندگی
• نوکری کیسے تلاش کی جائے؟ ریزیومے بھیجنے کے لیے نکات