Ngoptimalake karya karo proyek sampeyan ing GitHub: kenalan karo Repositori Cithakan Github

Halo kabeh, komunitas JavaRush! Dina iki kita bakal ngomong babagan sumber terbuka lan apa sing dibutuhake kanggo nggawe proyek sing bermutu SAMBUNG kode sing ditulis. Penting kanggo nulis produk sing migunani. Nanging ora kurang penting yaiku desain repositori sing bener (repositori proyek ing GitHub). Iki bakal mbantu ngetrapake titik kunci liyane - promosi produk. Malah yen proyèk punika super kelangan, nanging yen wis dirancang lingkungan, ora diterangake ing paling ing README (sampeyan bisa maca bab apa README punika ) , lisensi ora dituduhake, etc., etc., bakal ana. ora sukses. Mung wae ora ana sing nggatekake dheweke. Lan yen ana sing weruh, dheweke ora bakal ngerti carane sesambungan karo dheweke. Ana akeh perkara sing kudu diisi maneh, lan ora gampang programer bisa nyalin lan nempel saben wektu, lan mung kanggo musim panas iki, GitHub ngeculake fitur Repositori Cithakan sing mbantu. Dadi, kanggo ngotomatisasi proses nggawe proyek anyar. Dina iki kita bakal ngerti apa Repositori lan apa Repositori Cithakan. Kita bakal njlèntrèhaké apa sing kudu ana ing proyek saliyane kode, apa sing kudu sampeyan fokusake. Ayo nggawe Repositori Cithakan saka awal lan nambah kabeh sing perlu saka sudut pandangku. Lan pungkasane, kita bakal nggunakake Repositori Cithakan nalika nggawe repositori anyar. Nanging pisanan, ayo ngerti istilah kasebut. Teori: apa sing kudu ana ing repositori umum proyek apa wae Saben proyek open source ing GitHub kudu duwe Profil Komunitas sing diterangake kanthi apik , sing ngemot unsur-unsur ing ngisor iki.

1. Cithakan Jeksa Agung bisa ngetokake

Ing kene sampeyan kudu njlèntrèhaké aturan kanggo nggawe masalah ing gudang: apa sing kudu diarani, apa label kasebut, sing bakal ditugasake. Nalika nggawe Masalah anyar, pilihan ing ngisor iki bakal ditawakake:

• Laporan bug - nggawe masalah kanggo nggambarake cacat ing proyek kasebut;
• Panyuwunan fitur - proposal ide anyar kanggo proyek;
• Panjaluk perbaikan - proposal kanggo perbaikan proyek;
• Cithakan masalah khusus - yen opsi liyane ora bisa digunakake, sampeyan bisa nggunakake cithakan kosong.

Conto sing katon kaya iki bisa dideleng ing kene .

2. Lisensi

Lisensi ing ngendi proyek kasebut ditulis. Perlu supaya wong-wong sing bakal nggunakake proyek ngerti apa sing dijamin lan apa sing ora. Contone, Lisensi Apache 2.0 ujar ing ngisor iki:

3. WACANA

Iki minangka katrangan babagan proyek kasebut, kertu telpon. Kabeh sing kudu dikandhakake babagan proyek kasebut kudu ana ing kene. Mesthine, saben wektu kudu diterangake, kanthi nganggep spesifik proyek kasebut, nanging judhul bakal padha. Tuladhane:

• Ringkesan - gambaran singkat proyek;
• Panggunaan - carane nggunakake proyek;
• Bangunan - carane miwiti proyek, apa sing dibutuhake kanggo iki;
• Ngatasi masalah - iki njlèntrèhaké masalah apa sing bisa ditemoni lan cara ngatasi;
• Cathetan Rilis - katrangan babagan owah-owahan gumantung versi;
• Penulis - aja lali babagan wong sing dikasihi;
• Kontribusi - gambaran babagan carane sampeyan bisa melu ing pangembangan proyek;
• Kode Etik - deskripsi aturan partisipasi;
• RELEASE_NOTES - file sing kabeh owah-owahan kanggo versi anyar direkam. Iku laku apik kanggo sijine iki ing document kapisah lan nyimpen link ing README;
• CONTRIBUTING minangka file sing nerangake carane sampeyan bisa nyumbang kanggo pangembangan proyek iki. Digawe minangka file kapisah kanggo header Kontribusi ing README;
• CODE_OF_CONDUCT - file sing njlèntrèhaké aturan kanggo melu ing pangembangan proyek;
• Cithakan Panjaluk Tarik - cithakan kanggo sing bakal nggawe panjalukan tarik.

Kabeh iki digunakake saka proyek menyang proyek, preduli saka basa pamrograman utawa spesifike.

Praktek: nggawe template dhewe

Kaya sing dikandhakake, ayo pindhah saka tembung menyang tumindak. Saiki, nggunakake conto, aku bakal nuduhake sampeyan carane nggawe template sampeyan dhewe.

1. Babagan pisanan sing sampeyan butuhake yaiku akun ing GitHub / ndhaftar ing kana .

2. Gawe repositori anyar: kanggo nindakake iki, klik + ing pojok tengen ndhuwur

3. Nalika nggawe, isi:

   • Jeneng repositori - ing kasusku repositori-template;
   • Description - gambaran singkat saka project;
   • Kita ninggalake Umum, sanajan sampeyan bisa milih Pribadi;
   • Priksa kothak inisialisasi README:

   • Pilih lisensi sing bakal dadi proyek kasebut:

     Wiwit ing kasusku, cithakan kasebut umum, gitignore ora dibutuhake: bakal ditambahake kanggo proyek lan basa pamrograman tartamtu.

     Mulane, klik Gawe Repositori , kanthi mangkono ngrampungake proses nggawe. Sistem bakal kanthi otomatis nggawa kita menyang repositori sing mentas digawe.

4. Isi Profil Komunitas : ing repositori sing digawe, pindhah menyang tab Insights banjur pilih Komunitas :

   Kaya sing sampeyan ngerteni, sing isih ana yaiku ngisi Code of Conduce, Contributing, Issue Template, Pull Request template.

   Nggunakake conto Kode Etik, kita bakal nuduhake carane nambahake menyang proyek.

   Klik nambah , sistem njaluk sampeyan milih Prajanjian Kontributor utawa Kode Etik Warga :

   Aku milih sing pisanan lan klik Review lan Kirim .

   Sabanjure, sampeyan bisa ngowahi file iki lan nglakoni.

   Ing sisih ngisor, pilih Komit langsung menyang pilihan cabang master banjur klik Komit file anyar :

   Akibaté, yen kita bali menyang Profil Komunitas , kita bakal nemokake yen Kode Etik ditandhani minangka ditambahake:

   Cithakan Kontribusi lan Masalah ditambahake kanthi cara sing padha, mula aku ora bakal nuduhake iki. Gawe dhewe ;)

5. Tambah Cithakan Panjaluk Tarik .

   Nanging ayo ngomong babagan iki kanthi kapisah.

   Aku ora ngerti kenapa GitHub ora nambahake pilihan sing padha kanggo nyetel template Pull-Request, dadi sampeyan kudu sinau dokumentasi lan nambah kanthi manual.

   Kanggo nindakake iki, klik Gawe file anyar ing root repositori :

   Jeneng berkas kudu: .github/pull_request_template.md .

   Kita nambahake apa sing dibutuhake ing cithakan lan klik Komit file anyar , kaya sing kita tindakake ing ndhuwur. Aku ora arep reinvent setir lan nemokake conto sing ketoke cukup migunani kanggo kula.

   Kanthi cara iki kabeh Profil Komunitas bakal diisi:

6. Tambah panandha Repositori Cithakan .

   Kanggo nindakake iki, pindhah menyang pilihan Setelan ing repositori lan priksa kothak ing ngendi kasebut Repositori Cithakan:

   Lan iku, cithakan kanggo nggawe proyek anyar wis siyap. Mangkono, kita bakal ngirit akeh wektu ing mangsa ngarep nalika kita kudu nggawe proyek anyar. Iki uga bakal mbantu ora kantun rincian penting, wiwit asring kelakon sing lali kanggo nambah soko, contone lisensi utawa cithakan cetha kanggo masalah.

Cara nggunakake Repositori Cithakan

Ana rong pilihan kanggo nggunakake:

1. Nalika cithakan diduweni langsung dening sampeyan: Nalika nggawe repositori anyar, sampeyan bakal diwenehi pilihan kanggo nggawe saka cithakan saka dhaptar cithakan sampeyan duwe:

2. Nalika cithakan manca: ora ana masalah khusus ing kene. Pindhah menyang cithakan kasebut banjur klik tombol Gunakake template iki . Ing kene aku bakal nggunakake animasi saka doc resmi:

Ayo padha nyimpulake

Ing artikel iki kita ndeleng:

• apa repositori GitHub;
• apa Repositori Cithakan;
• apa sing kudu ana ing repositori Cithakan;
• carane nggawe Repositori Cithakan;
• carane nggunakake Repositori Cithakan.

Mesthi, adhedhasar cithakan iki, sampeyan wis bisa nggawe sing luwih spesifik. Contone, aku nggawe luwih akeh template kanthi sistem mbangun maven utawa gradle sing wis dikonfigurasi. Salajengipun: sampeyan bisa nggawe Cithakan Repositori Boot Spring adhedhasar rong pungkasan. Kanggo nglumpukake kabeh template, aku nggawe organisasi template-repositori ing GitHub kanthi kabeh template. Langganan akun GitHubku

pranala migunani

• Organisasi karo kabeh cithakan aku digawe
• Blog GitHub: Gawe repositori anyar nganggo template repositori carane nggawe template kanggo repositori
• Pitulung GitHub: Babagan repositori babagan apa repositori.
• Pitulung GitHub: Nggawe repositori saka cithakan carane nggawe proyek anyar adhedhasar cithakan
• Pitulung GitHub: Lisensi deskripsi repositori lisensi kanggo proyek
• Pitulung GitHub: Nggawe deskripsi repo kanggo nggawe repositori
• Tip Open Source Guides kanggo nggawe / njlentrehake proyek open-source.
• Pitulung GitHub: nambahake cithakan panjalukan tarik - nggawe cithakan kanggo panjalukan tarik.

Liyane saka artikelku

• Debug ing Intellij IDEA: pandhuan kanggo pamula
• Pandhuan kanggo nggawe klien kanggo Skyscanner API lan nerbitake ing jCenter lan Maven Central [Part 1]
• Pandhuan kanggo nggawe klien kanggo Skyscanner API lan nerbitake ing jCenter lan Maven Central [Part 2]
• Nggawe sistem pemantauan rega tiket udara: pandhuan langkah-langkah [Part 1]
• Nggawe sistem pemantauan rega tiket udara: pandhuan langkah-langkah [Part 2]
• Nggawe sistem pemantauan rega tiket udara: pandhuan langkah-langkah [Part 3]
• Logging: apa, carane, ngendi lan karo apa?
• Kepiye tes wawancara dadi perpustakaan sumber terbuka
• Sajarah sukses. 20 jam program saben minggu, gelar master lan urip pribadi
• Carane golek proyek? Tip kanggo ngirim resume