GitHub تي توهان جي منصوبن سان ڪم کي بهتر بڻائڻ: Github ٽيمپليٽ مخزن سان واقف ٿيڻ

هيلو هرڪو، JavaRush ڪميونٽي! اڄ اسان اوپن سورس جي باري ۾ ڳالهائينداسين ۽ اهو لکندو ڪوڊ جي اضافي ۾ هڪ اعليٰ معيار جو پروجيڪٽ ٺاهڻ لاءِ ڇا وٺندو آهي. اهو ضروري آهي ته هڪ مفيد پراڊڪٽ لکڻ لاء. پر ڪو به گهٽ اهم آهي مخزن جي صحيح ڊيزائن (GitHub تي پروجيڪٽ مخزن). اهو هڪ ٻيو اهم نقطو لاڳو ڪرڻ ۾ مدد ڪندو - پيداوار جي واڌاري. جيتوڻيڪ پروجيڪٽ تمام سٺو آهي، پر جيڪڏهن اهو ناقص ٺهيل آهي، گهٽ ۾ گهٽ README ۾ بيان نه ڪيو ويو آهي (توهان پڙهي سگهو ٿا ته هتي README ڇا آهي )، لائسنس ظاهر نه ڪيو ويو آهي، وغيره وغيره وغيره. ڪابه ڪاميابي. اهو صرف ايترو آهي ته ڪو به هن کي نوٽيس نه ڪندو. ۽ جيڪڏهن ڪو نوٽيس وٺي، انهن کي خبر ناهي ته هن سان ڪيئن لهه وچڙ ۾. اتي ڪيتريون ئي شيون آھن جن کي بار بار ڀرڻ جي ضرورت آھي، ۽ پروگرامر لاءِ ھر دفعي ڪاپي ۽ پيسٽ ڪرڻ آسان ناھي، ۽ صرف ان لاءِ، ھن اونهاري ۾، GitHub ٽيمپليٽ ريپوزٽري فيچر جاري ڪيو جيڪو ھن سان مدد ڪري ٿو. تنهنڪري ڳالهائڻ، نئين منصوبن ٺاهڻ جي عمل کي خودڪار ڪرڻ لاء. اڄ اسان سمجھنداسين ته ريپوزٽري ڇا آھي ۽ ٽيمپليٽ ريپوزٽري ڇا آھي. اسان بيان ڪنداسين ته پروجيڪٽ ۾ ڪوڊ کان علاوه ڇا هجڻ گهرجي، ڪهڙيون شيون توهان کي ڌيان ڏيڻ جي ضرورت آهي. اچو ته شروع کان هڪ ٽيمپليٽ ريپوزٽري ٺاهيو ۽ منهنجي نقطي نظر کان هر ضروري شيءِ شامل ڪريون. ۽ آخرڪار، اسان استعمال ڪنداسين ٽيمپليٽ مخزن جڏهن هڪ نئون مخزن ٺاهيو. پر پهرين، اچو ته اصطلاحن کي سمجھو. ٿيوري: ڪنهن به پراجيڪٽ جي عام مخزن ۾ ڇا هجڻ گهرجي GitHub تي هر اوپن سورس پروجيڪٽ کي سٺو بيان ڪيل ڪميونٽي پروفائل هجڻ گهرجي ، جنهن ۾ هيٺيان عنصر شامل آهن.

1. مسئلو سانچو

هتي توهان کي مخزن ۾ هڪ مسئلو پيدا ڪرڻ لاء قاعدن جي وضاحت ڪرڻ جي ضرورت آهي: انهن کي ڇا سڏيو وڃي، ڇا ليبل هوندو، جيڪو ان کي مقرر ڪيو ويندو. جڏهن هڪ نئون مسئلو ٺاهي، هيٺين اختيارن کي پيش ڪيو ويندو:

• بگ رپورٽ - پروجيڪٽ ۾ نقص بيان ڪرڻ لاءِ مسئلو پيدا ڪرڻ؛
• خصوصيت جي درخواست - منصوبي لاء نئين خيال جي تجويز؛
• بهتري جي درخواست - پروجيڪٽ تي بهتري جي تجويز؛
• ڪسٽم مسئلو ٽيمپليٽ - جيڪڏهن ٻيا اختيار ڪم نه ڪن، توهان هڪ خالي ٽيمپليٽ استعمال ڪري سگهو ٿا.

ان جو هڪ مثال هي ڏسڻ جهڙو آهي هتي .

2. لائسنس

لائسنس جنهن تحت پروجيڪٽ لکيو ويو آهي. اهو ضروري آهي ته اهي جيڪي منصوبي کي استعمال ڪندا، ڄاڻن ٿا ته ڇا ضمانت آهي ۽ ڇا نه آهي. مثال طور، Apache لائسنس 2.0 هيٺ ڏنل چوي ٿو:

3. README

هن منصوبي جو هڪ تفصيل آهي، ان جي ڪالنگ ڪارڊ. هر شي جي ضرورت آهي ته منصوبي جي باري ۾ چيو وڃي هتي هجڻ گهرجي. يقينن، ان کي هر وقت بيان ڪرڻ جي ضرورت پوندي، منصوبي جي خاصيتن کي نظر ۾ رکندي، پر عنوان ساڳيا هوندا. مثال طور:

• جائزو - منصوبي جو هڪ مختصر بيان؛
• استعمال - منصوبي کي ڪيئن استعمال ڪجي؛
• عمارت - ڪيئن هڪ منصوبي شروع ڪرڻ لاء، هن لاء ڇا جي ضرورت آهي؛
• مسئلو حل ڪرڻ - هي بيان ڪري ٿو ته توهان ڪهڙيون مشڪلاتون منهن ڏئي سگهو ٿا ۽ انهن کي ڪيئن حل ڪيو وڃي؛
• رليز نوٽس - تبديلين جو بيان نسخي تي منحصر آهي؛
• ليکڪ - پنهنجن پيارن جي باري ۾ نه وساريو؛
• حصو ڏيڻ - هڪ وضاحت ته توهان ڪيئن منصوبي جي ترقي ۾ حصو وٺي سگهو ٿا؛
• ضابطا اخلاق - شرڪت جي ضابطن جي وضاحت؛
• RELEASE_NOTES - هڪ فائيل جنهن ۾ سڀني تبديلين کي نئين نسخن لاء رڪارڊ ڪيو ويو آهي. اھو ھڪڙو سٺو عمل آھي ھن کي الڳ دستاويز ۾ رکڻ ۽ ھڪڙي لنڪ کي README ۾ ذخيرو ڪرڻ؛
• CONTRIBUTING هڪ فائل آهي جيڪا بيان ڪري ٿي ته توهان هن منصوبي جي ترقي ۾ ڪيئن مدد ڪري سگهو ٿا. README ۾ حصو وٺندڙ هيڊر لاءِ الڳ فائل طور ٺاهيو ويو؛
• CODE_OF_CONDUCT - ھڪڙي فائل جيڪا بيان ڪري ٿي منصوبي جي ترقي ۾ حصو وٺڻ لاء ضابطا؛
• پل درخواست ٽيمپليٽ - انهن لاءِ هڪ ٽيمپليٽ جيڪي پل-درخواست ٺاهيندا.

اهي سڀ شيون استعمال ڪيون وينديون آهن پروجيڪٽ کان پروجيڪٽ تائين، پروگرامنگ ٻولي يا ان جي خاصيتن کان سواءِ.

مشق: توهان جي پنهنجي ٽيمپليٽ ٺاهڻ

جيئن اهي چون ٿا، اچو ته لفظن کان عمل ڏانهن وڃو. ھاڻي، ھڪڙو مثال استعمال ڪندي، مان توھان کي ڏيکاريندس توھان جو پنھنجو ٽيمپليٽ ڪيئن ٺاھيو.

1. پهرين شيء جيڪا توهان کي گهربل آهي GitHub تي هڪ اڪائونٽ آهي / اتي رجسٽر ڪريو .

2. نئون مخزن ٺاھيو: ھن کي ڪرڻ لاءِ، ڪلڪ ڪريو + مٿي ساڄي ڪنڊ ۾

3. ٺاھڻ وقت، ڀريو:

   • مخزن جو نالو - منهنجي صورت ۾ مخزن-سامان؛
   • وضاحت - منصوبي جي مختصر وضاحت؛
   • اسان عوامي ڇڏي ڏيون ٿا، جيتوڻيڪ توھان منتخب ڪري سگھو ٿا پرائيويٽ؛
   • چيڪ ڪريو README شروعاتي باڪس:

   • لائسنس چونڊيو جنهن تحت پروجيڪٽ ٿيندو:

     جيئن ته منهنجي صورت ۾ ٽيمپليٽ عام آهي، gitignore جي ضرورت ناهي: اهو هڪ مخصوص پروجيڪٽ ۽ پروگرامنگ ٻولي لاءِ شامل ڪيو ويندو.

     تنهن ڪري، ڪلڪ ڪريو Repository ٺاھيو ، اھڙي طرح ٺاھڻ جي عمل کي مڪمل ڪريو. سسٽم خودڪار طريقي سان اسان کي نئين ٺاهيل مخزن ڏانهن وٺي ويندي.

4. ڪميونٽي جي پروفائيل کي ڀرڻ : ٺاهيل مخزن ۾، وڃو Insights ٽيب ۽ چونڊيو ڪميونٽي :

   جئين توهان ڏسي سگهو ٿا، باقي رهي ٿو ڀرڻ لاءِ ڪوڊ آف ڪنڊيس، حصو ڏيڻ، مسئلو ٽيمپليٽ، پل درخواست ٽيمپليٽ.

   مثال طور ضابطه اخلاق استعمال ڪندي، اسين ڏيکارينداسين ته ڪيئن انهن کي پروجيڪٽ ۾ شامل ڪجي.

   شامل ڪريو تي ڪلڪ ڪريو ، سسٽم توھان کي منتخب ڪرڻ جو اشارو ڏئي ٿو Contributor Covenant يا Citizen Code of Conduct :

   مان پهريون چونڊيو ۽ ڪلڪ ڪريو جائزو ۽ جمع ڪريو .

   اڳيون، توھان ھن فائل کي تبديل ڪري سگھو ٿا ۽ ان کي انجام ڏيو.

   تري ۾، چونڊيو ڪميٽ سڌو سنئون ماسٽر برانچ آپشن تي ۽ ڪلڪ ڪريو Commit new file :

   نتيجي طور، جيڪڏھن اسان ڪميونٽي پروفائل ڏانھن واپس وڃون ٿا ، اسان کي معلوم ٿيندو ته ضابطا اخلاق شامل ڪيو ويو آھي:

   حصو ڏيڻ ۽ شماري سان ٺهيل هڪجهڙائي سان شامل ڪيا ويا آهن، تنهنڪري مان اهو نه ڏيکاريندس. اهو توهان پاڻ ڪريو ؛)

5. شامل ڪريو پل درخواست ٽيمپليٽ .

   پر اسان ان بابت الڳ الڳ ڳالهائينداسين.

   مون کي خبر ناهي ته ڇو GitHub پل-درخواست ٽيمپليٽ کي ترتيب ڏيڻ لاءِ ساڳيو آسان آپشن شامل نه ڪيو آهي، تنهنڪري توهان کي دستاويز جو مطالعو ڪرڻو پوندو ۽ ان کي دستي طور شامل ڪرڻو پوندو.

   ائين ڪرڻ لاءِ، ڪلڪ ڪريو نئين فائل ٺاھيو مخزن جي روٽ ۾ :

   فائل جو نالو هجڻ گهرجي: .github/pull_request_template.md .

   اسان کي شامل ڪريون ٿا جيڪو اسان کي گهرجي ٽيمپليٽ ۾ ۽ ڪلڪ ڪريو Commit new file ، جيئن اسان مٿي ڪيو آهي. مان ان ڦيٿي کي ٻيهر ايجاد ڪرڻ وارو نه هوس ۽ هڪ مثال مليو جيڪو مون لاءِ ڪافي استعمال لائق لڳي رهيو هو.

   هن طريقي سان سڄي ڪميونٽي پروفائل ڀريو ويندو:

6. هڪ ٽيمپليٽ مخزن مارڪر شامل ڪريو .

   ائين ڪرڻ لاءِ، مخزن ۾ سيٽنگون اختيار ڏانھن وڃو ۽ باڪس چيڪ ڪريو جتي اھو چوي ٿو Template Repository:

   ۽ اهو ئي آهي، نئين منصوبن ٺاهڻ لاء ٽيمپليٽ تيار آهي. اهڙيء طرح، اسان مستقبل ۾ گهڻو وقت بچائي سگهنداسين جڏهن اسان کي نئين منصوبن ٺاهڻ جي ضرورت آهي. اهو پڻ توهان جي مدد ڪندو ته توهان اهم تفصيلن کي نه وڃايو، ڇاڪاڻ ته اهو اڪثر ڪري ٿو ته توهان ڪجهه شامل ڪرڻ وساريندا آهيو، مثال طور، لائسنس يا ڪنهن مسئلي لاء واضح ٽيمپليٽ.

Template Repository ڪيئن استعمال ڪجي

استعمال لاء ٻه اختيار آهن:

1. جڏهن هڪ ٽيمپليٽ سڌو سنئون توهان جي ملڪيت آهي: جڏهن هڪ نئين مخزن ٺاهيندي، توهان کي اختيار ڏنو ويندو ٽيمپليٽ جي فهرست مان هڪ ٽيمپليٽ ٺاهڻ جو توهان جي مالڪ آهي:

2. جڏهن ٽيمپليٽ غير ملڪي آهي: هتي ڪي خاص مسئلا نه آهن. ان ٽيمپليٽ ڏانھن وڃو ۽ ھن ٽيمپليٽ کي استعمال ڪريو بٽڻ تي ڪلڪ ڪريو . هتي آئون سرڪاري دستاويز مان اينيميشن استعمال ڪندس:

اچو ته ان جو خلاصو

هن آرٽيڪل ۾ اسان ڏٺو ته:

• GitHub مخزن ڇا آهي؛
• Template repository ڇا آهي؛
• ٽيمپليٽ مخزن ۾ ڇا هجڻ گهرجي؛
• هڪ ٽيمپليٽ مخزن ڪيئن ٺاهيو؛
• ڪيئن استعمال ڪجي Template Repository.

يقينا، هن ٽيمپليٽ جي بنياد تي، توهان اڳ ۾ ئي وڌيڪ مخصوص ٺاهي سگهو ٿا. مثال طور، مون اڳ ۾ ئي ترتيب ڏنل ميون يا گرڊل بلڊ سسٽم سان وڌيڪ ٽيمپليٽ ٺاهيا آهن. وڌيڪ وڌيڪ: توهان ٺاهي سگهو ٿا اسپرنگ بوٽ ريپوزٽري ٽيمپليٽ آخري ٻن جي بنياد تي. سڀني ٽيمپليٽس کي گروپ ڪرڻ لاءِ، مون GitHub تي سڀني ٽيمپليٽس سان گڏ ٽيمپليٽ ريپوزٽري تنظيم ٺاهي. منهنجي 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 ڪلاڪ پروگرامنگ في هفتي، ماسٽر جي ڊگري ۽ ذاتي زندگي
• نوڪري ڪيئن ڳولجي؟ ٻيهر شروع موڪلڻ لاءِ صلاحون