GitHub-da loyihalaringiz bilan ishlashni optimallashtirish: Github shablonlari ombori bilan tanishish

Hammaga salom, JavaRush jamoasi! Bugun biz ochiq manba va yozilgan kodga QO'SHIMCHA yuqori sifatli loyiha yaratish uchun nima qilish kerakligi haqida gaplashamiz . Foydali mahsulotni yozish muhim. Ammo omborning to'g'ri dizayni (GitHub-dagi loyiha ombori) muhim emas. Bu yana bir muhim nuqta - mahsulotni reklama qilishni amalga oshirishga yordam beradi. Agar loyiha juda ajoyib bo'lsa ham, lekin u yomon ishlab chiqilgan bo'lsa ham, hech bo'lmaganda README-da tasvirlanmagan bo'lsa ham (siz README nima ekanligini bu erda o'qishingiz mumkin ), litsenziya ko'rsatilmagan va hokazo va hokazo. muvaffaqiyat yo'q. Shunchaki, uni hech kim sezmaydi. Va agar kimdir buni sezsa, u bilan qanday munosabatda bo'lishni bilmaydi. Qayta-qayta to'ldirish kerak bo'lgan juda ko'p narsalar mavjud va dasturchi uchun har safar nusxa ko'chirish va joylashtirish oson emas va faqat buning uchun, bu yozda GitHub bunda yordam beradigan Shablonlar ombori xususiyatini chiqardi . Shunday qilib aytganda, yangi loyihalarni yaratish jarayonini avtomatlashtirish. Bugun biz ombor nima ekanligini va shablonlar ombori nima ekanligini tushunamiz. Biz loyihada koddan tashqari nima bo'lishi kerakligini, qaysi narsalarga e'tibor qaratish kerakligini tasvirlab beramiz. Keling, shablonlar omborini noldan yarataylik va mening nuqtai nazarimdan barcha kerakli narsalarni qo'shamiz. Va nihoyat, biz yangi omborni yaratishda Shablonlar omboridan foydalanamiz. Lekin avval shartlarni tushunib olaylik. Nazariya: har qanday loyihaning umumiy omborida nima boʻlishi kerak GitHub’dagi har bir ochiq manba loyihasida quyidagi elementlarni oʻz ichiga olgan yaxshi tavsiflangan Jamoa profili boʻlishi kerak.

1. Nashr shabloni

Bu erda siz omborda muammo yaratish qoidalarini tavsiflashingiz kerak: ular nima deb nomlanishi kerak, yorliq qanday bo'ladi, unga kim tayinlanadi. Yangi muammo yaratishda quyidagi variantlar taklif etiladi:

• Xatolar haqida hisobot - loyihadagi nuqsonni tavsiflash uchun muammo yaratish;
• Xususiyat so'rovi - loyiha uchun yangi g'oya taklifi;
• Takomillashtirish so'rovi - loyihani takomillashtirish bo'yicha taklif;
• Maxsus muammo shabloni - agar boshqa variantlar ishlamasa, bo'sh shablondan foydalanishingiz mumkin.

Bu qanday ko'rinishga ega bo'lgan misolni bu erda ko'rish mumkin .

2. Litsenziya

Loyiha yozilgan litsenziya. Loyihadan foydalanadiganlar nima kafolatlangan va nima kafolatlanmaganligini bilishlari kerak. Masalan, Apache License 2.0 quyidagilarni aytadi:

3.README

Bu loyihaning tavsifi, uning tashrif qog'ozi. Loyiha haqida aytilishi kerak bo'lgan hamma narsa shu erda bo'lishi kerak. Albatta, uni har safar loyihaning o'ziga xos xususiyatlarini hisobga olgan holda tasvirlash kerak bo'ladi, lekin sarlavhalar bir xil bo'ladi. Masalan:

• Umumiy ko'rinish - loyihaning qisqacha tavsifi;
• Foydalanish - loyihadan qanday foydalanish kerak;
• Bino - loyihani qanday boshlash kerak, buning uchun nima kerak;
• Muammolarni bartaraf etish - bu siz qanday muammolarga duch kelishingiz mumkinligini va ularni qanday hal qilishni tavsiflaydi;
• Relizlar uchun eslatmalar - versiyaga qarab o'zgarishlar tavsifi;
• Mualliflar - yaqinlaringiz haqida unutmang;
• Hissa qo'shish - loyihani ishlab chiqishda qanday ishtirok etishingiz mumkinligi tavsifi;
• Xulq-atvor qoidalari - ishtirok etish qoidalarining tavsifi;
• RELEASE_NOTES - yangi versiyalar uchun barcha o'zgarishlar qayd etilgan fayl. Buni alohida hujjatga qo'yish va havolani README-da saqlash yaxshi amaliyotdir;
• HISSA QILISH - bu loyihani rivojlantirishga qanday hissa qo'shishingiz mumkinligini tasvirlaydigan fayl. README-dagi Contributing sarlavhasi uchun alohida fayl sifatida yaratilgan;
• CODE_OF_CONDUCT - loyihani ishlab chiqishda ishtirok etish qoidalarini tavsiflovchi fayl;
• Pull Request shabloni - pull-so'rovni yaratadiganlar uchun shablon.

Bularning barchasi dasturlash tilidan yoki uning o'ziga xos xususiyatlaridan qat'i nazar, loyihadan loyihaga qo'llaniladi.

Amaliyot: o'z shabloningizni yaratish

Ular aytganidek, keling, so'zdan harakatga o'tamiz. Endi misoldan foydalanib, men o'z shabloningizni qanday yaratishni ko'rsataman.

1. Sizga kerak bo'lgan birinchi narsa - bu GitHub'da hisob / u erda ro'yxatdan o'tish .

2. Yangi ombor yarating: buni amalga oshirish uchun yuqori o'ng burchakdagi + tugmasini bosing

3. Yaratishda quyidagilarni to'ldiring:

   • Repozitoriy nomi - mening ishimda ombor-shablon;
   • Tavsif — loyihaning qisqacha tavsifi;
   • Biz “Omma”ni qoldiramiz, garchi siz “Shaxsiy”ni tanlashingiz mumkin;
   • README ishga tushirish oynasini belgilang:

   • Loyiha bo'ladigan litsenziyani tanlang:

     Mening holimda shablon umumiy bo'lgani uchun gitignore kerak emas: u ma'lum bir loyiha va dasturlash tili uchun qo'shiladi.

     Shuning uchun, "Repository yaratish" ni bosing va shu bilan yaratish jarayonini yakunlang. Tizim bizni avtomatik ravishda yangi yaratilgan omborga olib boradi.

4. Hamjamiyat profilini toʻldirish : yaratilgan omborda “Insights” yorligʻiga oʻting va “Hamjamiyat” bandini tanlang :

   Ko'rib turganingizdek, faqat axloq kodeksi, hissa qo'shish, muammo shablonini, tortish so'rovi shablonini to'ldirish qoladi.

   Xulq-atvor kodeksi misolidan foydalanib, biz ularni loyihaga qanday qo'shishni ko'rsatamiz.

   Qo'shish tugmasini bosing , tizim sizga Contributor Covenant yoki Fuqarolik axloq kodeksini tanlashni taklif qiladi :

   Men birinchisini tanlayman va Ko'rib chiqish va yuborish tugmasini bosing .

   Keyinchalik, siz ushbu faylni tahrirlashingiz va uni topshirishingiz mumkin.

   Pastki qismida to'g'ridan-to'g'ri asosiy filialga topshirish opsiyasini tanlang va Yangi faylni topshirish tugmasini bosing :

   Natijada, agar biz hamjamiyat profiliga qaytsak, Xulq-atvor kodeksi qo'shilgan deb belgilanganini topamiz :

   Hissa qo‘shish va muammo shablonlari xuddi shunday tarzda qo‘shilgan, shuning uchun men buni ko‘rsatmayman. Buni o'zing qil ;)

5. Pull so'rovi shablonini qo'shing .

   Ammo biz bu haqda alohida gaplashamiz.

   Nima uchun GitHub Pull-Request shablonini o'rnatish uchun bir xil qulay variantni qo'shmaganini bilmayman, shuning uchun siz hujjatlarni o'rganishingiz va uni qo'lda qo'shishingiz kerak bo'ladi.

   Buni amalga oshirish uchun ombor ildizida yangi fayl yaratish tugmasini bosing :

   Fayl nomi quyidagicha bo'lishi kerak: .github/pull_request_template.md .

   Biz shablonga kerakli narsalarni qo'shamiz va yuqorida qilganimizdek Yangi faylni topshirish tugmasini bosing. Men g'ildirakni qayta ixtiro qilmoqchi emas edim va menga juda foydali bo'lib tuyulgan misolni topdim .

   Shu tarzda butun Hamjamiyat profili to‘ldiriladi:

6. Shablon ombori markerini qo'shing .

   Buni amalga oshirish uchun ombordagi Sozlamalar opsiyasiga o'ting va shablonlar ombori degan katakchani belgilang:

   Va bu, yangi loyihalarni yaratish uchun shablon tayyor. Shunday qilib, biz kelajakda yangi loyihalar yaratish kerak bo'lganda ko'p vaqtni tejaymiz. Bu sizga muhim tafsilotlarni o'tkazib yubormaslikka yordam beradi, chunki siz ko'pincha biror narsa, masalan, litsenziya yoki muammo uchun aniq shablonni qo'shishni unutib qo'yishingiz mumkin.

Shablonlar omboridan qanday foydalanish kerak

Foydalanish uchun ikkita variant mavjud:

1. Shablon bevosita sizga tegishli boʻlsa: Yangi ombor yaratishda sizga oʻzingizga tegishli shablonlar roʻyxatidan shablondan yaratish imkoniyati beriladi:

2. Shablon xorijiy bo'lsa: bu erda ham maxsus muammolar yo'q. Ushbu shablonga o'ting va " Ushbu shablondan foydalanish" tugmasini bosing . Bu erda men rasmiy hujjatdagi animatsiyadan foydalanaman:

Keling, xulosa qilaylik

Ushbu maqolada biz ko'rib chiqdik:

• GitHub ombori nima;
• andozalar ombori nima;
• Andoza omborida nima bo'lishi kerak;
• shablonlar omborini qanday yaratish kerak;
• Shablonlar omboridan qanday foydalanish kerak.

Albatta, ushbu shablonga asoslanib, siz allaqachon aniqroq narsalarni yaratishingiz mumkin. Misol uchun, men allaqachon konfiguratsiya qilingan maven yoki gradle qurish tizimlari bilan ko'proq shablonlarni yaratdim. Qo'shimcha: oxirgi ikkitasi asosida Spring Boot Repository shablonini yaratishingiz mumkin. Barcha shablonlarni guruhlash uchun men GitHub-da barcha shablonlarga ega shablon-repozitoriy tashkilotini yaratdim. Mening GitHub hisobimga obuna bo'ling

foydali havolalar

• Men yaratgan barcha andozalar bilan tashkilot
• GitHub blogi: ombor shablonlari bilan yangi omborni yarating, omborlar uchun shablonni qanday yaratish kerak
• GitHub Yordam: Repozitariylar nima ekanligi haqida omborlar haqida.
• GitHub yordami: shablondan ombor yaratish, shablon asosida yangi loyihani qanday yaratish mumkin
• GitHub yordami: Loyihalar uchun litsenziyalashning ombor tavsifini litsenziyalash
• GitHub Yordam: Repository yaratishning repo tavsifini yarating
• Open Source Guides ochiq manbali loyihalarni yaratish/tariflash uchun maslahatlar.
• GitHub yordami: tortish so'rovi shablonini qo'shish - tortib olish so'rovlari uchun shablon yaratish.

Ko'proq maqolalarim

• Intellij IDEA-da disk raskadrovka: yangi boshlanuvchilar uchun qo'llanma
• Skyscanner API uchun mijoz yaratish va uni jCenter va Maven Central-da nashr qilish bo'yicha qo'llanma [1-qism]
• Skyscanner API uchun mijoz yaratish va uni jCenter va Maven Central-da nashr qilish bo'yicha qo'llanma [2-qism]
• Aviachiptalar narxini monitoring qilish tizimini yaratish: bosqichma-bosqich qo'llanma [1-qism]
• Aviachiptalar narxini monitoring qilish tizimini yaratish: bosqichma-bosqich qo'llanma [2-qism]
• Aviachiptalar narxini monitoring qilish tizimini yaratish: bosqichma-bosqich qo'llanma [3-qism]
• Jurnal: nima, qanday, qaerda va nima bilan?
• Qanday qilib intervyu testi ochiq manba kutubxonasiga aylandi
• Muvaffaqiyat tarixi. Haftada 20 soat dasturlash, magistratura va shaxsiy hayot
• Qanday qilib ish topish mumkin? Rezyumelarni yuborish bo'yicha maslahatlar