Mengoptimumkan kerja dengan projek anda di GitHub: berkenalan dengan Repositori Templat Github

Hello semua, komuniti JavaRush! Hari ini kita akan bercakap tentang sumber terbuka dan perkara yang diperlukan untuk mencipta projek berkualiti tinggi SELAIN kod yang ditulis. Adalah penting untuk menulis produk yang berguna. Tetapi tidak kurang pentingnya ialah reka bentuk repositori yang betul (repositori projek di GitHub). Ini akan membantu dalam melaksanakan satu lagi perkara penting - promosi produk. Walaupun projek itu sangat keren, tetapi jika ia direka bentuk dengan buruk, tidak diterangkan sekurang-kurangnya dalam README (anda boleh membaca tentang apa itu README di sini ), lesen tidak ditunjukkan, dsb., tidak akan berjaya. Cuma tiada siapa yang akan perasan dia. Dan jika seseorang perasan, mereka tidak akan tahu bagaimana untuk berinteraksi dengannya. Terdapat banyak perkara yang perlu diisi berulang kali, dan bukan mudah bagi pengaturcara untuk menyalin dan menampal setiap kali, dan hanya untuk ini, musim panas ini, GitHub mengeluarkan ciri Repositori Templat yang membantu dengan ini. Jadi untuk bercakap, untuk mengautomasikan proses mencipta projek baharu. Hari ini kita akan memahami apa itu Repositori dan apa itu Repositori Templat. Kami akan menerangkan perkara yang sepatutnya ada dalam projek selain kod, perkara yang perlu anda fokuskan. Mari buat Repositori Templat dari awal dan tambahkan semua yang diperlukan dari pandangan saya. Dan akhirnya, kami akan menggunakan Repositori Templat apabila mencipta repositori baharu. Tetapi pertama, mari kita fahami termanya. Teori: perkara yang sepatutnya ada dalam repositori umum mana-mana projek Setiap projek sumber terbuka di GitHub harus mempunyai Profil Komuniti yang diterangkan dengan baik , yang mengandungi elemen berikut.

1. Templat keluaran

Di sini anda perlu menerangkan peraturan untuk mencipta isu dalam repositori: apa yang sepatutnya dipanggil, apa label itu, siapa yang akan diberikan kepadanya. Apabila mencipta Isu baharu, pilihan berikut akan ditawarkan:

• Laporan pepijat - mencipta isu untuk menerangkan kecacatan dalam projek;
• Permintaan ciri - cadangan idea baharu untuk projek;
• Permintaan penambahbaikan - cadangan penambahbaikan ke atas projek;
• Templat keluaran tersuai - jika pilihan lain tidak berfungsi, anda boleh menggunakan templat kosong.

Contoh rupa perkara ini boleh dilihat di sini .

2. Lesen

Lesen di mana projek itu ditulis. Ia perlu supaya mereka yang akan menggunakan projek itu tahu apa yang dijamin dan apa yang tidak. Sebagai contoh, Lesen Apache 2.0 menyatakan perkara berikut:

3.README

Ini ialah perihalan projek, kad panggilannya. Segala-galanya yang perlu dikatakan mengenai projek itu harus ada di sini. Sudah tentu, ia perlu diterangkan setiap kali, dengan mengambil kira spesifikasi projek, tetapi tajuknya akan sama. Sebagai contoh:

• Gambaran Keseluruhan - penerangan ringkas mengenai projek;
• Penggunaan - cara menggunakan projek;
• Bangunan - bagaimana untuk melancarkan projek, apa yang diperlukan untuk ini;
• Penyelesaian masalah - ini menerangkan masalah yang mungkin anda hadapi dan cara menyelesaikannya;
• Nota Keluaran - perihalan perubahan bergantung pada versi;
• Pengarang - jangan lupa tentang orang yang anda sayangi;
• Menyumbang - penerangan tentang cara anda boleh mengambil bahagian dalam pembangunan projek;
• Tatakelakuan - perihalan peraturan penyertaan;
• RELEASE_NOTES - fail di mana semua perubahan untuk versi baharu direkodkan. Amalan yang baik untuk meletakkan ini dalam dokumen yang berasingan dan menyimpan pautan dalam README;
• MENYUMBANG ialah fail yang menerangkan cara anda boleh menyumbang kepada pembangunan projek ini. Dibuat sebagai fail berasingan untuk pengepala Menyumbang dalam README;
• CODE_OF_CONDUCT - fail yang menerangkan peraturan untuk mengambil bahagian dalam pembangunan projek;
• Templat Permintaan Tarik - templat untuk mereka yang akan membuat permintaan tarik.

Semua perkara ini digunakan dari projek ke projek, tanpa mengira bahasa pengaturcaraan atau spesifiknya.

Amalan: mencipta templat anda sendiri

Seperti yang mereka katakan, mari kita beralih dari perkataan ke tindakan. Sekarang, menggunakan contoh, saya akan menunjukkan kepada anda cara membuat templat anda sendiri.

1. Perkara pertama yang anda perlukan ialah akaun di GitHub / daftar di sana .

2. Cipta repositori baharu: untuk melakukan ini, klik + di penjuru kanan sebelah atas

3. Semasa membuat, isikan:

   • Nama repositori - dalam kes saya templat repositori;
   • Penerangan — penerangan ringkas projek;
   • Kami meninggalkan Awam, walaupun anda boleh memilih Persendirian;
   • Semak kotak permulaan README:

   • Pilih lesen di mana projek itu akan:

     Oleh kerana dalam kes saya templat adalah umum, gitignore tidak diperlukan: ia akan ditambah untuk projek dan bahasa pengaturcaraan tertentu.

     Oleh itu, klik Cipta Repositori , dengan itu melengkapkan proses penciptaan. Sistem akan secara automatik membawa kami ke repositori yang baru dibuat.

4. Mengisi Profil Komuniti : dalam repositori yang dibuat, pergi ke tab Insights dan pilih Komuniti :

   Seperti yang anda lihat, yang tinggal hanyalah mengisi Kod Kelakuan, Menyumbang, Templat Isu, templat Permintaan Tarik.

   Menggunakan contoh Tatakelakuan, kami akan menunjukkan cara menambahkannya pada projek.

   Klik tambah , sistem menggesa anda untuk memilih Perjanjian Penyumbang atau Tatakelakuan Warganegara :

   Saya pilih yang pertama dan klik Semak dan Hantar .

   Seterusnya, anda boleh mengedit fail ini dan mengikatnya.

   Di bahagian bawah, pilih pilihan Komit terus ke cawangan induk dan klik Komit fail baharu :

   Akibatnya, jika kita kembali ke Profil Komuniti , kita akan mendapati bahawa Tatakelakuan ditandakan sebagai ditambahkan:

   Templat Sumbangan dan Isu ditambahkan dengan cara yang sama, jadi saya tidak akan menunjukkannya. Buat sendiri ;)

5. Tambah templat Permintaan Tarik .

   Tetapi kita akan membincangkan perkara ini secara berasingan.

   Saya tidak tahu mengapa GitHub tidak menambah pilihan mudah yang sama untuk menyediakan templat Pull-Request, jadi anda perlu mengkaji dokumentasi dan menambahkannya secara manual.

   Untuk melakukan ini, klik Cipta fail baharu dalam akar repositori :

   Nama fail hendaklah: .github/pull_request_template.md .

   Kami menambah apa yang kami perlukan pada templat dan klik Komit fail baharu , seperti yang kami lakukan di atas. Saya tidak akan mencipta semula roda dan menemui contoh yang kelihatan agak boleh digunakan kepada saya.

   Dengan cara ini seluruh Profil Komuniti akan diisi:

6. Tambah penanda Repositori Templat .

   Untuk melakukan ini, pergi ke pilihan Tetapan dalam repositori dan tandai kotak yang tertera Repositori Templat:

   Dan itu sahaja, templat untuk mencipta projek baharu sudah sedia. Oleh itu, kami akan menjimatkan banyak masa pada masa hadapan apabila kami perlu membuat projek baharu. Ini juga akan membantu anda untuk tidak terlepas butiran penting, kerana selalunya anda terlupa untuk menambah sesuatu, contohnya lesen atau templat yang jelas untuk sesuatu isu.

Cara menggunakan Repositori Templat

Terdapat dua pilihan untuk digunakan:

1. Apabila templat dimiliki secara langsung oleh anda: Apabila membuat repositori baharu, anda akan diberi pilihan untuk mencipta daripada templat daripada senarai templat yang anda miliki:

2. Apabila templat adalah asing: tiada masalah khas di sini sama ada. Pergi ke templat itu dan klik butang Gunakan templat ini . Di sini saya akan menggunakan animasi dari dokumen rasmi:

Mari kita ringkaskan

Dalam artikel ini kami melihat:

• apakah repositori GitHub;
• apakah repositori Templat;
• apa yang sepatutnya ada dalam repositori Templat;
• cara membuat Repositori Templat;
• cara menggunakan Repositori Templat.

Sudah tentu, berdasarkan templat ini, anda sudah boleh membuat yang lebih khusus. Sebagai contoh, saya mencipta lebih banyak templat dengan sistem binaan maven atau gradle yang telah dikonfigurasikan. Lebih lanjut: anda boleh mencipta Templat Repositori Spring Boot berdasarkan dua yang terakhir. Untuk mengumpulkan semua templat, saya mencipta organisasi repositori templat di GitHub dengan semua templat. Langgan akaun GitHub saya

pautan yang berguna

• Organisasi dengan semua templat yang saya buat
• Blog GitHub: Hasilkan repositori baharu dengan templat repositori cara membuat templat untuk repositori
• Bantuan GitHub: Mengenai repositori tentang apa itu repositori.
• Bantuan GitHub: Mencipta repositori daripada templat cara membuat projek baharu berdasarkan templat
• Bantuan GitHub: Melesenkan perihalan repositori pelesenan untuk projek
• Bantuan GitHub: Cipta perihalan repo untuk membuat repositori
• Petua Panduan Sumber Terbuka untuk mencipta/menghuraikan projek sumber terbuka.
• Bantuan GitHub: menambah templat permintaan tarik - mencipta templat untuk permintaan tarik.

Lagi artikel saya

• Nyahpepijat dalam Intellij IDEA: panduan untuk pemula
• Panduan untuk mencipta pelanggan untuk API Skyscanner dan menerbitkannya dalam jCenter dan Maven Central [Bahagian 1]
• Panduan untuk mencipta pelanggan untuk API Skyscanner dan menerbitkannya dalam jCenter dan Maven Central [Bahagian 2]
• Mencipta sistem pemantauan harga tiket penerbangan: panduan langkah demi langkah [Bahagian 1]
• Mencipta sistem pemantauan harga tiket penerbangan: panduan langkah demi langkah [Bahagian 2]
• Mencipta sistem pemantauan harga tiket penerbangan: panduan langkah demi langkah [Bahagian 3]
• Pembalakan: apa, bagaimana, di mana dan dengan apa?
• Bagaimana ujian temu duga bertukar menjadi perpustakaan sumber terbuka
• Sejarah kejayaan. 20 jam pengaturcaraan seminggu, ijazah sarjana dan kehidupan peribadi
• Macam mana nak cari kerja? Petua untuk menghantar resume