Mengoptimalkan pekerjaan dengan proyek Anda di GitHub: mengenal Repositori Templat Github

Halo semuanya, komunitas JavaRush! Hari ini kita akan berbicara tentang open source dan apa yang diperlukan untuk membuat proyek berkualitas tinggi SELAIN kode yang ditulis. Penting untuk menulis produk yang bermanfaat. Namun yang tidak kalah pentingnya adalah desain repositori yang benar (repositori proyek di GitHub). Ini akan membantu dalam menerapkan poin penting lainnya - promosi produk. Sekalipun proyeknya sangat keren, tetapi jika dirancang dengan buruk, tidak dijelaskan setidaknya di README (Anda dapat membaca tentang apa itu README di sini ), lisensi tidak disebutkan, dll., dll., akan ada tidak berhasil. Hanya saja tidak ada yang akan memperhatikannya. Dan jika seseorang memperhatikannya, mereka tidak akan tahu bagaimana cara berinteraksi dengannya. Ada banyak hal yang perlu diisi berulang kali, dan tidak mudah bagi pemrogram untuk menyalin dan menempel setiap saat, dan hanya untuk ini, musim panas ini, GitHub merilis fitur Repositori Templat yang membantu dalam hal ini. Artinya, untuk mengotomatiskan proses pembuatan proyek baru. Hari ini kita akan memahami apa itu Repository dan apa itu Template Repository. Kami akan menjelaskan apa saja yang harus ada dalam proyek selain kode, hal-hal apa saja yang perlu Anda fokuskan. Mari buat Repositori Templat dari awal dan tambahkan semua yang diperlukan menurut sudut pandang saya. Dan terakhir, kita akan menggunakan Template Repository saat membuat repositori baru. Tapi pertama-tama, mari kita pahami istilahnya. Teori: apa yang harus ada dalam repositori umum proyek apa pun Setiap proyek sumber terbuka di GitHub harus memiliki Profil Komunitas yang dijelaskan dengan baik , yang berisi elemen-elemen berikut.

1. Templat terbitan

Di sini Anda perlu menjelaskan aturan untuk membuat masalah di repositori: apa namanya, apa labelnya, siapa yang akan ditugaskan padanya. Saat membuat Masalah baru, opsi berikut akan ditawarkan:

• Laporan bug - membuat masalah untuk menjelaskan cacat pada proyek;
• Permintaan fitur - proposal ide baru untuk suatu proyek;
• Permintaan perbaikan - proposal untuk perbaikan proyek;
• Templat terbitan khusus - jika opsi lain tidak berfungsi, Anda dapat menggunakan templat kosong.

Contoh tampilannya dapat dilihat di sini .

2. Lisensi

Lisensi dimana proyek tersebut ditulis. Hal ini diperlukan agar pihak yang akan menggunakan proyek tersebut mengetahui apa yang dijamin dan apa yang tidak. Misalnya, Lisensi Apache 2.0 menyatakan sebagai berikut:

3.BACA SAYA

Ini adalah deskripsi proyek, ciri khasnya. Segala sesuatu yang perlu dikatakan tentang proyek ini harus ada di sini. Tentu saja, hal ini perlu dijelaskan setiap saat, dengan mempertimbangkan spesifikasi proyek, tetapi judulnya akan sama. Misalnya:

• Ikhtisar - deskripsi singkat tentang proyek;
• Penggunaan - cara menggunakan proyek;
• Bangunan - cara meluncurkan proyek, apa yang dibutuhkan untuk ini;
• Pemecahan masalah - ini menjelaskan masalah apa yang mungkin Anda temui dan cara mengatasinya;
• Catatan Rilis - deskripsi perubahan tergantung pada versi;
• Penulis - jangan lupakan orang yang Anda cintai;
• Berkontribusi - deskripsi tentang bagaimana Anda dapat berpartisipasi dalam pengembangan proyek;
• Kode Etik - deskripsi aturan partisipasi;
• RELEASE_NOTES - file yang menyimpan semua perubahan untuk versi baru. Merupakan praktik yang baik untuk menempatkan ini dalam dokumen terpisah dan menyimpan tautannya di README;
• CONTRIBUTING adalah file yang menjelaskan bagaimana Anda dapat berkontribusi pada pengembangan proyek ini. Dibuat sebagai file terpisah untuk header Contributing di README;
• CODE_OF_CONDUCT - file yang menjelaskan aturan untuk berpartisipasi dalam pengembangan proyek;
• Templat Permintaan Tarik - templat untuk mereka yang akan membuat permintaan tarik.

Semua hal ini digunakan dari proyek ke proyek, terlepas dari bahasa pemrograman atau spesifikasinya.

Latihan: membuat template Anda sendiri

Seperti kata pepatah, mari beralih dari kata-kata ke tindakan. Sekarang, dengan menggunakan contoh, saya akan menunjukkan cara membuat template Anda sendiri.

1. Hal pertama yang Anda perlukan adalah akun di GitHub / daftar di sana .

2. Buat repositori baru: untuk melakukannya, klik + di sudut kanan atas

3. Saat membuat, isi:

   • Nama repositori - dalam kasus saya, templat repositori;
   • Deskripsi — deskripsi singkat proyek;
   • Kami membiarkan Publik, meskipun Anda dapat memilih Pribadi;
   • Centang kotak inisialisasi README:

   • Pilih lisensi di mana proyek tersebut akan dibuat:

     Karena dalam kasus saya templatnya bersifat umum, gitignore tidak diperlukan: templat akan ditambahkan untuk proyek dan bahasa pemrograman tertentu.

     Oleh karena itu, klik Buat Repositori , sehingga menyelesaikan proses pembuatan. Sistem secara otomatis akan membawa kita ke repositori yang baru dibuat.

4. Mengisi Profil Komunitas : pada repositori yang dibuat, buka tab Insights dan pilih Komunitas :

   Seperti yang Anda lihat, yang tersisa hanyalah mengisi template Code of Conduce, Contributing, Issue Template, Pull Request.

   Dengan menggunakan contoh Kode Etik, kami akan menunjukkan cara menambahkannya ke sebuah proyek.

   Klik tambahkan , sistem akan meminta Anda memilih Perjanjian Kontributor atau Kode Etik Warga :

   Saya pilih yang pertama dan klik Tinjau dan Kirim .

   Selanjutnya, Anda dapat mengedit file ini dan mengkomitnya.

   Di bagian bawah, pilih opsi Komit langsung ke cabang master dan klik Komit file baru :

   Hasilnya, jika kita kembali ke Profil Komunitas , kita akan menemukan bahwa Kode Etik ditandai dengan tambahan:

   Templat Kontribusi dan Edisi ditambahkan dengan cara serupa, jadi saya tidak akan menampilkannya. Lakukan sendiri ;)

5. Tambahkan templat Permintaan Tarik .

   Tapi mari kita bicarakan ini secara terpisah.

   Saya tidak tahu mengapa GitHub belum menambahkan opsi praktis yang sama untuk menyiapkan template Pull-Request, jadi Anda harus mempelajari dokumentasi dan menambahkannya secara manual.

   Untuk melakukannya, klik Buat file baru di root repositori :

   Nama file harus: .github/pull_request_template.md .

   Kami menambahkan apa yang kami perlukan ke templat dan klik Komit file baru , seperti yang kami lakukan di atas. Saya tidak akan menemukan kembali roda dan menemukan contoh yang tampaknya cukup bermanfaat bagi saya.

   Dengan cara ini seluruh Profil Komunitas akan terisi:

6. Tambahkan penanda Repositori Templat .

   Untuk melakukan ini, buka opsi Pengaturan di repositori dan centang kotak yang bertuliskan Repositori Templat:

   Selesai, template untuk membuat proyek baru sudah siap. Dengan demikian, kita akan menghemat banyak waktu di masa depan ketika kita perlu membuat proyek baru. Ini juga akan membantu Anda untuk tidak melewatkan detail penting, karena sering kali Anda lupa menambahkan sesuatu, misalnya lisensi atau template yang jelas untuk suatu masalah.

Cara menggunakan Repositori Templat

Ada dua opsi untuk digunakan:

1. Ketika sebuah templat dimiliki langsung oleh Anda: Saat membuat repositori baru, Anda akan diberikan opsi untuk membuat dari templat dari daftar templat yang Anda miliki:

2. Jika templatenya asing: tidak ada masalah khusus di sini juga. Buka templat itu dan klik tombol Gunakan templat ini . Di sini saya akan menggunakan animasi dari dokumen resmi:

Mari kita simpulkan

Dalam artikel ini kita melihat:

• apa itu repositori GitHub;
• apa itu repositori Templat;
• apa yang seharusnya ada di repositori Templat;
• cara membuat Repositori Templat;
• cara menggunakan Repositori Templat.

Tentunya berdasarkan template ini Anda sudah bisa membuat yang lebih spesifik. Misalnya, saya membuat lebih banyak template dengan sistem build maven atau gradle yang sudah dikonfigurasi. Lebih jauh lagi: Anda dapat membuat Templat Repositori Spring Boot berdasarkan dua yang terakhir. Untuk mengelompokkan semua templat, saya membuat organisasi repositori templat di GitHub dengan semua templat. Berlangganan ke akun GitHub saya

tautan yang bermanfaat

• Organisasi dengan semua templat yang saya buat
• Blog GitHub: Hasilkan repositori baru dengan templat repositori cara membuat templat untuk repositori
• Bantuan GitHub: Tentang repositori tentang apa itu repositori.
• Bantuan GitHub: Membuat repositori dari template cara membuat proyek baru berdasarkan template
• Bantuan GitHub: Melisensikan deskripsi repositori tentang lisensi untuk proyek
• Bantuan GitHub: Membuat deskripsi repo untuk membuat repositori
• Panduan Sumber Terbuka tips untuk membuat/mendeskripsikan proyek sumber terbuka.
• Bantuan GitHub: menambahkan templat permintaan tarik - membuat templat untuk permintaan tarik.

Lebih banyak artikel saya

• Debug di Intellij IDEA: panduan untuk pemula
• Panduan untuk membuat klien untuk Skyscanner API dan memublikasikannya di jCenter dan Maven Central [Bagian 1]
• Panduan untuk membuat klien untuk Skyscanner API dan memublikasikannya di jCenter dan Maven Central [Bagian 2]
• Membuat sistem pemantauan harga tiket pesawat: panduan langkah demi langkah [Bagian 1]
• Membuat sistem pemantauan harga tiket pesawat: panduan langkah demi langkah [Bagian 2]
• Membuat sistem pemantauan harga tiket pesawat: panduan langkah demi langkah [Bagian 3]
• Penebangan: apa, bagaimana, dimana dan dengan apa?
• Bagaimana tes wawancara berubah menjadi perpustakaan sumber terbuka
• Sejarah kesuksesan. Pemrograman 20 jam per minggu, gelar master dan kehidupan pribadi
• Bagaimana cara mencari pekerjaan? Tip untuk mengirimkan resume