Penurunan harga

Selamat siang, rekan-rekan! Setelah perjalanan pembelajaran yang panjang, semua orang ingin menunjukkan hasil mereka kepada pemberi kerja, dan menunjukkan kepada mereka hanya dari sisi terbaik dan profesional, bukan? Saya pikir ya. Oleh karena itu, selain proyek yang dirancang dan dilaksanakan dengan benar, kita juga harus mampu meresmikannya. Majikan tidak akan membaca semua kode proyek Anda untuk memahami tentang apa dan apa saja yang termasuk di dalamnya? Pada artikel ini, kami akhirnya akan merangkum dua hal sebelumnya, yaitu: Integrasi Berkelanjutan dan Cakupan Kode , dan mari kita pahami di halaman “depan” proyek sumber terbuka apa yang kami gunakan dalam proyek kami dan apa yang diwakilinya. Hari ini kami akan berbicara dengan Anda tentang Penurunan Harga, ajukan pertanyaan favorit kami: “Apa itu?” dan “Mengapa ini?”, mari kita cari tahu di mana ini digunakan dan bagaimana cara menggunakannya. Bahkan akan ada contohnya, kami akan mengimplementasikannya di proyek open source kami . Jadi ayo pergi!

Apa itu "Penurunan Harga"?

Karena Anda dan saya adalah pemrogram, kami akan segera membuka Google dan membuka tautan Wiki pertama , yang berbunyi: Markdown adalah bahasa markup ringan yang dibuat dengan tujuan menulis teks yang paling mudah dibaca dan diedit, tetapi cocok untuk konversi ke bahasa untuk publikasi tingkat lanjut (HTML, Rich Text, dan lainnya). Di sini sejujurnya tidak banyak yang ingin saya tambahkan, menurut saya ini penjelasan yang hampir sempurna.

Mengapa kita membutuhkan "Penurunan Harga" ini?

Sejujurnya, sebenarnya tidak buruk tanpanya :D Tapi mari kita ingat tujuan kita: menulis template proyek yang kompeten yang sudah memiliki Integrasi Berkelanjutan dan memiliki statistik Cakupan Kode pada sumber daya Codecov. Mengapa saya menyebutkan hal ini? Selain itu, Markdown akan memungkinkan kami mengambil data dari sumber daya ini dan menyediakan data itu sendiri, atau lencana yang akan mengarahkan kami ke tempat yang kami perlukan untuk mendapatkan informasi ini. Akan lebih mudah untuk memiliki semuanya dalam satu halaman “judul”, daripada tersebar di tempat yang berbeda, bukan?

Di mana itu digunakan?

Siapa pun yang setidaknya pernah mengunggah salah satu proyeknya ke GitHub tahu bahwa GitHub terus-menerus ingin mengundang Anda untuk membuat file README: Apa ekstensi file ini? Benar, Bolt tahu Markdown! Seperti yang sudah kita ketahui, file ini sangat mudah disesuaikan dengan banyak format dan diubah menjadi HTML yang kita butuhkan. Namun mari kita luangkan waktu dan jangan terburu-buru untuk segera menambahkannya langsung ke GitHub.

Bagaimana cara mengatasinya?

Pertama, seperti yang mungkin Anda ketahui, kami dapat menambahkannya langsung ke GitHub dan itu akan berhasil! Namun kita tidak selalu perlu menambahkannya ke satu proyek saja, misalnya. Atau misalnya kita ingin lebih memikirkan bagaimana cara kita membuatnya. Dan di sini GitHub tidak lagi cocok untuk kita. Dan secara umum, kita dapat membuat file Markdown tidak hanya untuk tujuan mendorongnya ke GitHub. Kedua, kita bisa membuatnya langsung melalui IDEA, dan itulah yang akan kita lakukan, tapi tidak langsung, karena mengapa kita memerlukan lingkungan pengembangan yang kuat untuk menulis satu file kecil? Di sini saya sarankan menelusuri katalog editor file Markdown yang mudah, dan tidak begitu mudah. Bagi saya sendiri, saya memilih Haroopad , sangat sederhana, mudah diakses, memiliki representasi instan dari apa yang Anda tulis (IDEA juga demikian), dan memiliki petunjuk sintaksis. Ini adalah tampilan jendela editor: Di sini saya membuka README.md yang sudah jadi dari salah satu proyek saya. Di sebelah kiri adalah contekan, di sebelah kanan adalah tampilan, di tengah adalah teks. Semuanya sangat primitif dan sederhana. Anda juga dapat melihat lencana, yang akan segera kita bicarakan. Mereka yang memilih cara berbeda untuk menulis file-file ini - jangan khawatir, yang berbeda hanyalah antarmuka grafis. Teks, sintaksis, dan tampilan tidak akan berubah. Contoh Tugasnya sangat sederhana: tulis README.md sehingga berisi: informasi tentang proyek (termasuk lencana), informasi tentang impor proyek, informasi tentang pelaksanaan proyek, informasi tentang kontak penulis. Semuanya sangat sederhana dan primitif, seperti yang sudah saya katakan. Mari kita mulai berbisnis.

1. Mari kita tulis judul – nama proyek kita.

   Judul utama dan terbesar dibuat dengan menggunakan operator hash “ # ” kemudian judulnya ditulis. Dalam kasus kami:

   # ForJavaRushPublication

2. Kemudian kita akan menulis judul yang sedikit lebih kecil, dan kita akan menulis "Informasi Proyek". Header yang lebih kecil diawali dengan " # " yang lebih banyak:

   ## Information

   Dan kemudian kami akan menulis informasi tentang proyek tersebut.

3. Mari masukkan link ke artikel kita. Ini dilakukan dengan sangat sederhana, dan jika Anda menggunakan Haroopad, cukup ketik lembar contekan dan template akan dimasukkan dengan sendirinya. Sintaksnya adalah: " [teks](url) ";

4. Mari masukkan lencana. Mari kita lihat lebih dekat di sini.

   Pertama, mari kita susun dalam bentuk meja, untuk kecantikan. Akan ada 2 kolom dan 2 kolom. Sintaksnya akan terlihat seperti ini:

   Dan hasilnya akan seperti ini:

   Selanjutnya, kita akan menyisipkan hyperlink ke lencana kita, tapi di mana kita bisa mendapatkannya? Di artikel sebelumnya sudah saya tunjukkan di mana mendapatkan Codecov, namun saya tidak menyebutkan yang mana. Karena kita memiliki file Markdown, kita juga memerlukan Markdown Badge:

   Cukup salin dan tempel ke kolom di Penurunan Harga kami. Tapi jangan lupa Codecov muncul di cabang JaCoCo, tetapi tidak di master, jadi Anda harus memperbaikinya secara manual. Travis CI Badge diambil tepat di seberang nama proyek, dengan log buildnya adalah:

   Kami memilih lencana, dan kemudian jendela pengaturan muncul:

   Kami pasti memilih Markdown, dan cabang yang Anda butuhkan. Saya akan membuat README.md untuk dua cabang, dan keduanya akan sedikit berbeda, karena saya belum mengimplementasikan Codecov di cabang master.




5. Mari tulis informasi tentang cara mengimpor atau mengkloning proyek ini. Saya tidak akan menjelaskan cara melakukan ini, tetapi Anda dapat membacanya di README.md saya. Kami akan menulis tentang teknologi yang kami gunakan dalam proyek kami, menempatkan tautan ke sana. Namun, ini adalah proyek pendidikan. Baiklah, mari kita tuliskan informasi kontaknya.




6. Penurunan harga kami sudah siap. Yang harus kita lakukan adalah menambahkannya ke proyek kita dan selesai. Tapi tidak sekaligus! Mari buka IDEA kami, dan di Plugin kami memeriksa apakah Anda memiliki Dukungan Penurunan Harga:

   Saya memiliki Ultimate IDEA, jadi saya memiliki segalanya, plugin Anda mungkin tidak diinstal secara default, tetapi ketika Anda membuat file dengan ekstensi md, Anda akan diminta untuk mendownloadnya. Unduh dan mulai ulang IDE Anda.




7. Setelah mengimpor Markdown yang kami tulis, buka melalui IDEA dan edit jika perlu. Ini tampilannya melalui IDEA:

   Kami memang mendorong. Kemudian kita melihat ketika membuka sebuah proyek, informasi tentangnya langsung dimuat, ini README.md kita:

   Sekarang, ketika kita mengklik lencananya, kita dapat langsung menuju ke perakitan proyek dan melihat apa yang kita miliki di sana dan bagaimana caranya.




8. Saya akan melakukan hal yang sama untuk cabang JaCoCo untuk mendemonstrasikan Codecov Badge, karena kami belum memiliki README.md di dalamnya. Hasilnya, kami sekarang memiliki dua lencana:

   Codecov menunjukkan persentase cakupan kode, dan itu juga dapat mengarahkan kita ke halaman Codecov dan menampilkan laporan cakupan kode terperinci.

tautan yang bermanfaat

• Apa yang Wiki beritahukan kepada kita tentang penurunan harga;
• Direktori Editor Penurunan Harga ;
• Haroopad yang saya rekomendasikan;
• Tentang Penurunan Harga di situs web JetBrains ;
• Navigator Penurunan Harga di JetBrains yang sama;
• Lencana dan segala sesuatu tentangnya. Di sini Anda dapat memilih gaya lencana apa pun dan menyesuaikannya sendiri;
• Bagaimana cara meningkatkan proyek sumber terbuka Anda? Artikel ini juga akan menjawab ;
• Artikel sebelumnya

Mari kita rangkum rangkaian artikel saya

1. Kami membahas apa itu CI, kegunaannya, dan cara menggunakannya di artikel pertama tentang Integrasi Berkelanjutan ;
2. Kami bermain-main dengan CC dan memahami apa itu dan mengapa diperlukan di artikel kedua tentang Cakupan Kode ;
3. Dan dalam artikel ini kita melihat apa itu Markdown, mengapa diperlukan dan bagaimana menggunakannya secara efektif.

Terima kasih semuanya telah membaca ketiga artikel panjang ini, semoga bermanfaat. Mungkin ada kesalahan dan kekurangan dalam teks. Terima kasih atas perhatian Anda!