تخفيض السعر

يوم جيد أيها الزملاء! بعد رحلة طويلة من التعلم، يرغب الجميع في إظهار ثمارهم لصاحب العمل، وإظهارها فقط من الجانب الأفضل والمهني، أليس كذلك؟ اعتقد نعم. لذلك، بالإضافة إلى تصميم المشروع وتنفيذه بشكل صحيح، نحتاج إلى أن نكون قادرين على إضفاء الطابع الرسمي عليه. لن يقرأ صاحب العمل كل كود المشروع الخاص بك لفهم ما يدور حوله وما الذي يتضمنه؟ في هذه المقالة، سنلخص أخيرًا الاثنين السابقين، وهما: التكامل المستمر وتغطية التعليمات البرمجية ، ودعنا نفهم على الورقة "الأمامية" للمشروع مفتوح المصدر ما استخدمناه في مشروعنا وما يمثله. سنتحدث إليكم اليوم عن Markdown، ونطرح أسئلتنا المفضلة: "ما هو؟" و"لماذا هذا؟"، دعونا نتعرف على مكان استخدامه وكيفية العمل معه. سيكون هناك أيضًا مثال، وسنقوم بتنفيذه في مشروعنا مفتوح المصدر . إذا هيا بنا!

ما هو "تخفيض السعر"؟

بما أنني وأنت مبرمجين، سنذهب فورًا إلى Google ونفتح رابط Wiki الأول ، والذي يقول: Markdown هي لغة ترميزية خفيفة الوزن تم إنشاؤها بهدف كتابة النص الأكثر قابلية للقراءة والتحرير، ولكنها مناسبة لـ التحويل إلى اللغات للمنشورات المتقدمة (HTML، Rich Text وغيرها). هنا، لأكون صادقًا، ليس لدي الكثير لأضيفه، أعتقد أن هذا تفسير مثالي تقريبًا.

لماذا نحتاج إلى هذا "تخفيض السعر"؟

لنكون صادقين، الأمر في الواقع ليس سيئًا بدونه:D ولكن دعونا نتذكر هدفنا: كتابة قالب مشروع كفؤ يحتوي بالفعل على تكامل مستمر ولديه إحصائيات تغطية التعليمات البرمجية على مورد Codecov. لماذا ذكرت هذا؟ علاوة على ذلك، سيسمح لنا Markdown بأخذ البيانات من هذه الموارد وتقديم البيانات نفسها، أو الشارات التي ستعيد توجيهنا إلى حيث نحتاج للحصول على هذه المعلومات. من الملائم أن يكون كل شيء في صفحة "عنوان" واحدة، بدلاً من أن يكون متناثرًا في أماكن مختلفة، أليس كذلك؟

أين يتم استخدامه؟

يعرف أي شخص قام بتحميل أي من مشاريعه إلى GitHub مرة واحدة على الأقل أن GitHub يريد باستمرار دعوتك لإنشاء ملف README: ما هو امتداد هذا الملف؟ هذا صحيح، بولت يعرف تخفيض السعر! كما نعلم بالفعل، يمكن تعديل هذا الملف بسهولة إلى العديد من التنسيقات وتحويله إلى HTML الذي نحتاجه. ولكن دعونا نأخذ وقتنا ولا نتسرع في إضافته مباشرة إلى GitHub على الفور.

كيفية العمل معها؟

أولاً، كما لاحظت، يمكننا إضافته مباشرة إلى GitHub وسيعمل! لكننا لا نحتاج دائمًا إلى إضافتها إلى مشروع واحد فقط، على سبيل المثال. أو على سبيل المثال نريد أن نفكر أكثر في كيفية إنشائه. وهنا لم يعد GitHub مناسبًا لنا. وبشكل عام، يمكننا إنشاء ملفات Markdown ليس فقط بغرض دفعها إلى GitHub. ثانيًا، يمكننا إنشاؤه مباشرة من خلال IDEA، وهو بالضبط ما سنفعله، ولكن ليس على الفور، لسبب أننا بحاجة إلى بيئة تطوير قوية لكتابة ملف صغير واحد؟ أوصي هنا بتصفح كتالوج برامج تحرير ملفات Markdown السهلة، وليس بهذه السهولة. بالنسبة لي، اخترت Haroopad ، فهو بسيط جدًا، ويمكن الوصول إليه، ويحتوي على تمثيل فوري لما تكتبه (IDEA كذلك)، ويحتوي على تلميح نحوي. هذا ما تبدو عليه نافذة المحرر: هنا قمت بفتح ملف README.md الجاهز لأحد مشاريعي. على اليسار توجد ورقة الغش، وعلى اليمين يوجد عرض، وفي المنتصف يوجد نص. كل شيء بدائي وبسيط للغاية. يمكنك أيضًا رؤية الشارات، والتي سنتحدث عنها قريبًا. أولئك الذين يختارون طريقة مختلفة لكتابة هذه الملفات - لا تنزعجوا، كل ما سيكون مختلفًا هو الواجهة الرسومية. سيبقى النص وبناء الجملة والعرض دون تغيير. مثال المهمة بسيطة للغاية: اكتب README.md بحيث يحتوي على: معلومات حول المشروع (بما في ذلك الشارات)، معلومات حول استيراد المشروع، معلومات حول تنفيذ المشروع، معلومات حول جهات اتصال المؤلف. كل شيء بسيط للغاية وبدائي، كما قلت بالفعل. دعونا ننكب على العمل.

1. لنكتب عنوانًا - اسم مشروعنا.

   يتم إنشاء العنوان الرئيسي والأكبر باستخدام عامل التجزئة " # " ومن ثم يتم كتابة العنوان. في حالتنا هذه:

   # ForJavaRushPublication

2. ثم سنكتب عنوانًا أصغر قليلاً، وسنكتب "معلومات المشروع". الرأس الأصغر يسبقه المزيد من " # ":

   ## Information

   وبعد ذلك سنكتب معلومات عن المشروع.

3. دعونا إدراج روابط لمقالاتنا. يتم ذلك بكل بساطة، وإذا كنت تستخدم Haroopad، فما عليك سوى كتابة ورقة الغش وسيتم إدراج القالب نفسه. بناء الجملة هو: " [نص](url) "؛

4. دعونا نقوم بإدراج الشارات. دعونا نلقي نظرة فاحصة هنا.

   أولاً، دعونا نرتبها على شكل طاولة، من أجل الجمال. سيكون هناك عمودين وعمودين. سيبدو بناء الجملة كالتالي:

   وستكون النتيجة هكذا:

   بعد ذلك، سنقوم بإدراج روابط تشعبية لشاراتنا، ولكن أين يمكننا الحصول عليها؟ لقد أوضحت في المقالة السابقة مكان الحصول على Codecov، لكنني لم أذكر أي منها يجب الحصول عليه. بما أن لدينا ملف Markdown، نحتاج أيضًا إلى شارة Markdown:

   ما عليك سوى نسخه ولصقه في عمود في Markdown الخاص بنا. لكن لا تنس أن Codecov ظهر في فرع JaCoCo، ولكن ليس في الملف الرئيسي، لذا سيتعين عليك تصحيحه يدويًا. يتم أخذ شارة Travis CI مقابل اسم المشروع مباشرة، حيث يكون سجل البناء:

   نختار الشارة، ثم تظهر لنا نافذة الإعدادات:

   نحن بالتأكيد نختار Markdown والفرع الذي تحتاجه. سأقوم بإنشاء README.md لفرعين، وسيكونان مختلفين قليلاً، لأنني لم أقم بعد بتطبيق Codecov في الفرع الرئيسي.




5. دعنا نكتب معلومات حول كيفية استيراد هذا المشروع أو استنساخه. لن أشرح كيفية القيام بذلك، ولكن يمكنك قراءتها في ملف README.md الخاص بي. سنكتب عن التقنيات التي استخدمناها في مشروعنا، ونضع روابط لها. ومع ذلك، هذا مشروع تعليمي. حسنًا، دعنا نكتب معلومات الاتصال.




6. تخفيض السعر الخاص بنا جاهز. كل ما يتعين علينا فعله هو إضافته إلى مشروعنا وقد انتهينا. ولكن ليس في كل مرة! دعونا نفتح فكرتنا، وفي المكونات الإضافية نتحقق من أن لديك دعم Markdown:

   لدي Ultimate IDEA، لذلك لدي كل شيء، قد لا يتم تثبيت المكون الإضافي الخاص بك بشكل افتراضي، ولكن عند إنشاء ملف بامتداد md، يجب أن يُطلب منك تنزيله. قم بتنزيل وإعادة تشغيل IDEA الخاص بك.




7. بعد استيراد Markdown الذي كتبناه، افتحه من خلال IDEA وقم بتحريره إذا لزم الأمر. هذا ما يبدو عبر IDEA:

   نحن ندفع. ثم نرى أنه عند فتح مشروع، يتم تحميل المعلومات المتعلقة به على الفور، وهذا هو ملف README.md الخاص بنا:

   الآن، عندما نضغط على الشارة، يمكننا الانتقال مباشرة إلى مجموعة المشروع ونرى ما لدينا هناك وكيف.




8. سأفعل الشيء نفسه بالنسبة لفرع JaCoCo من أجل إظهار شارة Codecov، لأنه ليس لدينا README.md فيه حتى الآن. ونتيجة لذلك، أصبح لدينا الآن شارتان:

   يعرض Codecov النسبة المئوية لتغطية الكود، ويمكنه أيضًا إعادة توجيهنا إلى صفحة Codecov وإظهار تقرير تفصيلي لتغطية الكود.

روابط مفيدة

• ما يخبرنا به موقع Wiki عن Markdown؛
• دليل المحررين تخفيض السعر ؛
• Haroopad الذي أوصي به؛
• حول Markdown على موقع JetBrains الإلكتروني ؛
• Markdown Navigator على نفس JetBrains؛
• الشارات وكل ما يتعلق بها. هنا يمكنك اختيار نمط أي شارة وتخصيصها بنفسك؛
• كيف تقوم بترقية مشروعك مفتوح المصدر؟ هذه المقالة سوف تجيب أيضا ؛
• المقال السابق

دعونا نلخص سلسلة مقالاتي

1. لقد نظرنا إلى ماهية CI والغرض منها وكيفية استخدامها في المقالة الأولى حول التكامل المستمر ؛
2. لقد جربنا CC وفهمنا ماهيتها وسبب الحاجة إليها في المقالة الثانية حول تغطية التعليمات البرمجية ؛
3. وفي هذه المقالة نظرنا إلى ماهية Markdown وسبب الحاجة إليها وكيفية استخدامها بشكل فعال.

أشكركم جميعًا على قراءة هذه المقالات الثلاثة الطويلة، وآمل أن تكون مفيدة. قد تكون هناك أخطاء وسهو في النص. شكرا لكم جميعا على اهتمامكم!