نشان لگانا

اچھا دن، ساتھیوں! سیکھنے کے ایک طویل سفر کے بعد، ہر کوئی آجر کو اپنا پھل دکھانا چاہتا ہے، اور انہیں صرف بہترین، پیشہ ورانہ پہلو سے دکھانا چاہتا ہے، ٹھیک ہے؟ مجھے لگتا ہے کہ ہاں. لہذا، صحیح طریقے سے ڈیزائن اور لاگو کیے گئے منصوبے کے علاوہ، ہمیں اسے رسمی شکل دینے کے قابل ہونے کی ضرورت ہے۔ آجر یہ سمجھنے کے لیے آپ کے تمام پروجیکٹ کوڈ نہیں پڑھے گا کہ یہ کس چیز کے بارے میں ہے اور اس میں کیا شامل ہے؟ اس مضمون میں، ہم آخر میں پچھلے دو کا خلاصہ کریں گے، یعنی: مسلسل انضمام اور کوڈ کوریج ، اور آئیے اوپن سورس پروجیکٹ کے "فرنٹ" شیٹ پر سمجھیں گے کہ ہم نے اپنے پروجیکٹ میں کیا استعمال کیا اور یہ کس چیز کی نمائندگی کرتا ہے۔ آج ہم آپ سے مارک ڈاؤن کے بارے میں بات کریں گے، اپنے پسندیدہ سوالات پوچھیں: "یہ کیا ہے؟" اور "یہ کیوں ہے؟"، آئیے معلوم کریں کہ یہ کہاں استعمال ہوتا ہے اور اس کے ساتھ کیسے کام کیا جائے۔ یہاں تک کہ ایک مثال بھی ہوگی، ہم اسے اپنے اوپن سورس پروجیکٹ میں نافذ کریں گے ۔ تو چلو چلتے ہیں!

"مارک ڈاؤن" کیا ہے؟

چونکہ آپ اور میں پروگرامر ہیں، ہم فوراً گوگل پر جائیں گے اور پہلا ویکی لنک کھولیں گے ، جو کہتا ہے: مارک ڈاؤن ایک ہلکی پھلکی مارک اپ لینگوئج ہے جسے سب سے زیادہ پڑھنے کے قابل اور آسانی سے ترمیم کرنے والے متن کو لکھنے کے مقصد کے ساتھ بنایا گیا ہے، لیکن اعلی درجے کی اشاعتوں کے لیے زبانوں میں تبدیلی (HTML، Rich Text اور دیگر)۔ یہاں، سچ پوچھیں تو، میرے پاس شامل کرنے کے لیے بہت کچھ نہیں ہے، میرے خیال میں یہ تقریباً کامل وضاحت ہے۔

ہمیں اس "مارک ڈاؤن" کی ضرورت کیوں ہے؟

سچ پوچھیں تو، اس کے بغیر یہ درحقیقت برا نہیں ہے :D لیکن آئیے اپنے مقصد کو یاد رکھیں: ایک قابل پروجیکٹ ٹیمپلیٹ لکھنا جس میں پہلے سے ہی مسلسل انضمام ہو اور Codecov وسائل پر کوڈ کوریج کے اعدادوشمار ہوں۔ میں نے اس کا ذکر کیوں کیا؟ مزید برآں، مارک ڈاؤن ہمیں ان وسائل سے ڈیٹا لینے اور خود ڈیٹا فراہم کرنے کی اجازت دے گا، یا بیجز جو ہمیں ری ڈائریکٹ کریں گے جہاں ہمیں یہ معلومات حاصل کرنے کی ضرورت ہے۔ ہر چیز کو مختلف جگہوں پر بکھرنے کے بجائے ایک "ٹائٹل" صفحہ پر رکھنا آسان ہے، ہے نا؟

یہ کہاں استعمال ہوتا ہے؟

کوئی بھی جس نے اپنا کوئی پروجیکٹ GitHub پر کم از کم ایک بار اپ لوڈ کیا ہے وہ جانتا ہے کہ GitHub مسلسل آپ کو README فائل بنانے کے لیے مدعو کرنا چاہتا ہے: اس فائل کی توسیع کیا ہے؟ یہ ٹھیک ہے، بولٹ مارک ڈاؤن کو جانتا ہے! جیسا کہ ہم پہلے ہی جانتے ہیں، یہ فائل بہت آسانی سے بہت سے فارمیٹس میں ایڈجسٹ ہو جاتی ہے اور ہمیں مطلوبہ HTML میں تبدیل کر دی جاتی ہے۔ لیکن آئیے اپنا وقت نکالیں اور اسے فوری طور پر GitHub میں شامل کرنے کے لیے جلدی نہ کریں۔

اس کے ساتھ کیسے کام کرنا ہے؟

سب سے پہلے، جیسا کہ آپ نے دیکھا ہو گا، ہم اسے براہ راست GitHub میں شامل کر سکتے ہیں اور یہ کام کرے گا! لیکن ہمیں ہمیشہ اسے صرف ایک پروجیکٹ میں شامل کرنے کی ضرورت نہیں ہے، مثال کے طور پر۔ یا مثال کے طور پر ہم اس بارے میں مزید سوچنا چاہتے ہیں کہ ہم اسے کیسے بناتے ہیں۔ اور یہاں GitHub اب ہمارے لیے موزوں نہیں ہے۔ اور عام طور پر، ہم مارک ڈاون فائلوں کو نہ صرف GitHub کی طرف دھکیلنے کے مقصد کے لیے بنا سکتے ہیں۔ دوم، ہم اسے براہ راست IDEA کے ذریعے بنا سکتے ہیں، جو بالکل وہی ہے جو ہم کریں گے، لیکن ابھی نہیں، اس وجہ سے کہ ہمیں ایک چھوٹی فائل لکھنے کے لیے ایک طاقتور ترقیاتی ماحول کی ضرورت کیوں ہے؟ یہاں میں مارک ڈاؤن فائل ایڈیٹرز کے آسان، اور اتنے آسان نہیں، کی کیٹلاگ کو براؤز کرنے کی تجویز کرتا ہوں۔ اپنے لیے، میں نے Haroopad کا انتخاب کیا ، یہ بہت آسان، قابل رسائی ہے، آپ جو کچھ لکھ رہے ہیں اس کی فوری نمائندگی کرتا ہے (IDEA بھی کرتا ہے)، اور اس میں نحوی اشارہ ہے۔ ایڈیٹر ونڈو اس طرح دکھائی دیتی ہے: یہاں میں نے اپنے ایک پروجیکٹ کا ریڈی میڈ README.md کھولا۔ بائیں طرف دھوکہ دہی کی شیٹ ہے، دائیں طرف ایک ڈسپلے ہے، بیچ میں متن ہے۔ سب کچھ بہت قدیم اور سادہ ہے۔ آپ بیجز بھی دیکھ سکتے ہیں، جن کے بارے میں ہم جلد ہی بات کریں گے۔ وہ لوگ جو ان فائلوں کو لکھنے کا ایک مختلف طریقہ منتخب کرتے ہیں - گھبرائیں نہیں، جو کچھ مختلف ہوگا وہ گرافیکل انٹرفیس ہے۔ متن، نحو اور ڈسپلے میں کوئی تبدیلی نہیں ہوگی۔ مثال کام بہت آسان ہے: README.md لکھیں تاکہ اس میں شامل ہوں: پراجیکٹ کے بارے میں معلومات (بشمول بیجز)، پراجیکٹ کو درآمد کرنے کے بارے میں معلومات، پراجیکٹ کے نفاذ کے بارے میں معلومات، مصنف کے رابطوں کے بارے میں معلومات۔ سب کچھ بہت سادہ اور قدیم ہے، جیسا کہ میں پہلے ہی کہہ چکا ہوں۔ اب کام کی طرف آ جائو.

1. آئیے ایک عنوان لکھتے ہیں - ہمارے پروجیکٹ کا نام۔

   ہیش آپریٹر " # " کا استعمال کرتے ہوئے مرکزی اور سب سے بڑی سرخی بنائی جاتی ہے اور پھر عنوان لکھا جاتا ہے۔ ہمارے معاملے میں:

   # ForJavaRushPublication

2. پھر ہم تھوڑا چھوٹا عنوان لکھیں گے، اور ہم "پروجیکٹ انفارمیشن" لکھیں گے۔ چھوٹے ہیڈر سے پہلے مزید " # " ہے:

   ## Information

   اور پھر ہم پروجیکٹ کے بارے میں معلومات لکھیں گے۔

3. آئیے اپنے مضامین کے لنکس ڈالتے ہیں۔ یہ بہت آسانی سے کیا جاتا ہے، اور اگر آپ ہاروپیڈ استعمال کرتے ہیں، تو صرف چیٹ شیٹ ٹائپ کریں اور ٹیمپلیٹ خود ہی داخل ہوجائے گا۔ نحو ہے: " [text](url) "؛

4. آئیے بیجز ڈالتے ہیں۔ آئیے یہاں قریب سے دیکھیں۔

   سب سے پہلے، آئیے انہیں ایک میز کی شکل میں ترتیب دیں، خوبصورتی کے لیے۔ 2 کالم اور 2 کالم ہوں گے۔ نحو کچھ اس طرح نظر آئے گا:

   اور نتیجہ اس طرح ہوگا:

   اگلا، ہم اپنے بیجز میں ہائپر لنکس داخل کریں گے، لیکن ہم انہیں کہاں سے حاصل کر سکتے ہیں؟ میں نے پچھلے مضمون میں دکھایا تھا کہ Codecov کہاں سے حاصل کرنا ہے، لیکن میں نے یہ نہیں بتایا کہ کون سا حاصل کرنا ہے۔ چونکہ ہمارے پاس مارک ڈاؤن فائل ہے، ہمیں مارک ڈاؤن بیج کی بھی ضرورت ہے:

   بس اسے کاپی کریں اور ہمارے مارک ڈاؤن میں ایک کالم میں چسپاں کریں۔ لیکن یہ نہ بھولیں کہ Codecov JaCoCo برانچ میں ظاہر ہوا، لیکن ماسٹر میں نہیں، لہذا آپ کو اسے دستی طور پر درست کرنا پڑے گا۔ Travis CI بیج براہ راست پروجیکٹ کے نام کے سامنے لیا جاتا ہے، جہاں بلڈ لاگ ہے:

   ہم بیج چنتے ہیں، اور پھر سیٹنگز ونڈو پاپ اپ ہوجاتی ہے:

   ہم یقینی طور پر مارک ڈاون اور وہ شاخ منتخب کرتے ہیں جس کی آپ کو ضرورت ہے۔ میں دو شاخوں کے لیے README.md بناؤں گا، اور وہ قدرے مختلف ہوں گے، کیونکہ میں نے ابھی تک ماسٹر برانچ میں Codecov کو لاگو نہیں کیا ہے۔




5. آئیے اس پراجیکٹ کو امپورٹ یا کلون کرنے کے بارے میں معلومات لکھتے ہیں۔ میں یہ نہیں بتاؤں گا کہ یہ کیسے کیا جائے، لیکن آپ اسے میرے README.md میں پڑھ سکتے ہیں۔ ہم ان ٹیکنالوجیز کے بارے میں لکھیں گے جو ہم نے اپنے پروجیکٹ میں استعمال کی ہیں، ان کے لنکس رکھیں گے۔ پھر بھی، یہ ایک تعلیمی منصوبہ ہے۔ ٹھیک ہے، آئیے رابطے کی معلومات لکھتے ہیں۔




6. ہمارا مارک ڈاؤن تیار ہے۔ ہمیں بس اسے اپنے پروجیکٹ میں شامل کرنا ہے اور ہم نے کام کر لیا۔ لیکن ایک ساتھ نہیں! آئیے اپنا IDEA کھولیں، اور پلگ انز میں ہم چیک کرتے ہیں کہ آپ کو مارک ڈاؤن سپورٹ حاصل ہے:

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




7. مارک ڈاؤن کو درآمد کرنے کے بعد جو ہم نے لکھا ہے، اسے IDEA کے ذریعے کھولیں اور اگر ضروری ہو تو اس میں ترمیم کریں۔ IDEA کے ذریعے ایسا لگتا ہے:

   ہم دھکا دیتے ہیں۔ پھر ہم دیکھتے ہیں کہ جب کوئی پروجیکٹ کھولتے ہیں تو اس کے بارے میں معلومات فوراً لوڈ ہو جاتی ہیں، یہ ہمارا README.md ہے:

   اب، جب ہم بیج پر کلک کرتے ہیں، تو ہم سیدھا پروجیکٹ اسمبلی میں جاسکتے ہیں اور دیکھ سکتے ہیں کہ ہمارے پاس وہاں کیا ہے اور کیسے۔




8. میں Codecov بیج کو ظاہر کرنے کے لیے JaCoCo برانچ کے لیے بھی ایسا ہی کروں گا، کیونکہ ہمارے پاس ابھی تک README.md نہیں ہے۔ نتیجے کے طور پر، اب ہمارے پاس دو بیجز ہیں:

   Codecov کوڈ کوریج کا فیصد دکھاتا ہے، اور یہ ہمیں Codecov صفحہ پر بھی بھیج سکتا ہے اور کوڈ کوریج کی تفصیلی رپورٹ دکھا سکتا ہے۔

مفید لنکس

• وکی ہمیں مارک ڈاؤن کے بارے میں کیا بتاتا ہے؛
• مارک ڈاؤن ایڈیٹرز ڈائرکٹری ؛
• ہاروپاد جس کی میں تجویز کرتا ہوں؛
• JetBrains کی ویب سائٹ پر مارک ڈاؤن کے بارے میں
• اسی JetBrains پر مارک ڈاؤن نیویگیٹر ؛
• بیجز اور ان کے بارے میں سب کچھ۔ یہاں آپ کسی بھی بیج کا انداز منتخب کر سکتے ہیں اور اسے اپنی مرضی کے مطابق بنا سکتے ہیں۔
• اپنے اوپن سورس پروجیکٹ کو کیسے اپ گریڈ کریں؟ یہ مضمون بھی جواب دے گا ؛
• پچھلا مضمون

آئیے اپنے مضامین کے سلسلے کا خلاصہ کرتے ہیں۔

1. ہم نے Continuous Integration کے بارے میں پہلے مضمون میں دیکھا کہ CI کیا ہے، یہ کس لیے ہے اور اسے کیسے استعمال کیا جائے ۔
2. ہم نے CC کے ساتھ کھیلا اور سمجھا کہ یہ کیا ہے اور کوڈ کوریج کے بارے میں دوسرے مضمون میں اس کی ضرورت کیوں ہے ۔
3. اور اس مضمون میں ہم نے دیکھا کہ مارک ڈاؤن کیا ہے، اس کی ضرورت کیوں ہے اور اسے مؤثر طریقے سے کیسے استعمال کیا جائے۔

ان تینوں طویل مضامین کو پڑھنے کے لیے آپ سب کا شکریہ، مجھے امید ہے کہ وہ کارآمد تھے۔ متن میں غلطیاں اور کوتاہیاں ہوسکتی ہیں۔ آپ کی توجہ کے لیے آپ سب کا شکریہ!