GitHub-da layihələrinizlə işin optimallaşdırılması: Github Şablon Repository ilə tanışlıq

Hamıya salam, JavaRush icması! Bu gün biz açıq mənbə və yazılan koda əlavə olaraq yüksək keyfiyyətli layihə yaratmaq üçün lazım olanlardan danışacağıq . Faydalı məhsul yazmaq vacibdir. Ancaq daha az əhəmiyyət kəsb etmir ki, repozitoriyanın düzgün dizaynı (GitHub-da layihə deposu). Bu, başqa bir əsas məqamı - məhsulun təşviqini həyata keçirməyə kömək edəcəkdir. Layihə super sərin olsa belə, lakin zəif dizayn edilibsə, heç olmasa README-də təsvir olunmayıbsa (README-nin nə olduğunu burada oxuya bilərsiniz ), lisenziya göstərilməyib və s. və s., olacaq. uğur yoxdur. Sadəcə, heç kim onun fərqinə varmayacaq. Və kimsə fərq etsə, onunla necə ünsiyyət quracağını bilməyəcək. Dəfələrlə doldurulmalı olan çox şey var və proqramçı üçün hər dəfə kopyalayıb yapışdırmaq asan deyil və sırf bunun üçün bu yay GitHub buna kömək edən Şablon Repository xüsusiyyətini buraxdı . Belə desək, yeni layihələrin yaradılması prosesini avtomatlaşdırmaq. Bu gün biz Repozitoriyanın nə olduğunu və Şablon Repozitorunun nə olduğunu anlayacağıq. Layihədə koddan başqa nələrin olması lazım olduğunu, hansı şeylərə diqqət yetirməli olduğunuzu təsvir edəcəyik. Sıfırdan Şablon Repozitoriyası yaradaq və mənim nöqteyi-nəzərimdən lazım olan hər şeyi əlavə edək. Və nəhayət, yeni repozitoriya yaradarkən Şablon Repozitoriyasından istifadə edəcəyik. Ancaq əvvəlcə şərtləri anlayaq. Nəzəriyyə: hər hansı bir layihənin ümumi deposunda nə olmalıdır GitHub-dakı hər bir açıq mənbəli layihədə aşağıdakı elementləri ehtiva edən yaxşı təsvir edilmiş İcma Profili olmalıdır .

1. Buraxılış şablonu

Burada depoda bir məsələ yaratmaq qaydalarını təsvir etməlisiniz: onlar nə adlandırılmalıdır, etiket nə olacaq, ona kim təyin ediləcək. Yeni Buraxılış yaratarkən aşağıdakı seçimlər təklif olunacaq:

• Səhv hesabatı - layihədə bir qüsuru təsvir etmək üçün bir məsələ yaratmaq;
• Xüsusiyyət sorğusu - layihə üçün yeni ideyanın təklifi;
• Təkmilləşdirmə sorğusu - layihə üzrə təkmilləşdirmə təklifi;
• Fərdi buraxılış şablonu - digər variantlar işləmirsə, boş şablondan istifadə edə bilərsiniz.

Bunun necə göründüyünə dair bir nümunə burada görülə bilər .

2. Lisenziya

Layihənin yazıldığı lisenziya. Lazımdır ki, layihədən istifadə edəcəklər bilsinlər ki, nəyə zəmanət verilir, nəyə zəmanət verilir. Məsələn, Apache License 2.0 aşağıdakıları deyir:

3. README

Bu, layihənin təsviri, onun danışıq kartıdır. Layihə haqqında deyiləcək hər şey burada olmalıdır. Təbii ki, onu hər dəfə layihənin xüsusiyyətləri nəzərə alınmaqla təsvir etmək lazım gələcək, lakin başlıqlar eyni olacaq. Misal üçün:

• Baxış - layihənin qısa təsviri;
• İstifadə - layihədən necə istifadə etmək olar;
• Bina - bir layihəni necə başlamaq lazımdır, bunun üçün nə lazımdır;
• Problemlərin aradan qaldırılması - bu, hansı problemlərlə qarşılaşa biləcəyinizi və onları necə həll edəcəyinizi təsvir edir;
• Buraxılış qeydləri - versiyadan asılı olaraq dəyişikliklərin təsviri;
• Müəlliflər - sevdikləriniz haqqında unutmayın;
• Töhfə - layihənin hazırlanmasında necə iştirak edə biləcəyinizin təsviri;
• Davranış Kodeksi - iştirak qaydalarının təsviri;
• RELEASE_NOTES - yeni versiyalar üçün bütün dəyişikliklərin qeydə alındığı fayl. Bunu ayrıca sənəddə yerləşdirmək və README-də keçid saxlamaq yaxşı təcrübədir;
• CONTRIBUTING bu layihənin inkişafına necə töhfə verə biləcəyinizi təsvir edən fayldır. README-də töhfə verən başlıq üçün ayrıca fayl kimi hazırlanmışdır;
• CODE_OF_CONDUCT - layihənin işlənib hazırlanmasında iştirak qaydalarını təsvir edən fayl;
• Pull Request şablonu - çəkmə sorğusu yaradanlar üçün şablon.

Bütün bunlar proqramlaşdırma dilindən və ya onun xüsusiyyətlərindən asılı olmayaraq layihədən layihəyə istifadə olunur.

Təcrübə: öz şablonunuzu yaradın

Necə deyərlər, sözdən əmələ keçək. İndi bir nümunədən istifadə edərək, öz şablonunuzu necə yaratacağınızı göstərəcəyəm.

1. Sizə lazım olan ilk şey GitHub-da hesab/ orada qeydiyyatdan keçməkdir .

2. Yeni bir depo yaradın: bunu etmək üçün yuxarı sağ küncdə + düyməsini basın

3. Yaradarkən aşağıdakıları doldurun:

   • Repository adı - mənim vəziyyətimdə repozitoriya-şablon;
   • Təsvir — layihənin qısa təsviri;
   • Siz Şəxsi seçə bilsəniz də, biz İctimaini tərk edirik;
   • README başlatma qutusunu yoxlayın:

   • Layihənin olacağı lisenziyanı seçin:

     Mənim vəziyyətimdə şablon ümumi olduğundan, gitignore lazım deyil: o, konkret layihə və proqramlaşdırma dili üçün əlavə olunacaq.

     Buna görə də, klikləyin Depozit Yarat , bununla da yaratma prosesini tamamlayın. Sistem bizi avtomatik olaraq yeni yaradılmış depoya aparacaq.

4. İcma Profilinin doldurulması : yaradılmış depoda, Məlumatlar sekmesine keçin və İcma seçin :

   Gördüyünüz kimi, Davranış Kodeksi, Töhfə, Məsələ Şablonu, Pull Sorğu şablonunu doldurmaq qalır.

   Davranış Məcəlləsindən istifadə edərək, biz onları layihəyə necə əlavə edəcəyimizi göstərəcəyik.

   Əlavə et düyməsinə klikləyin , sistem sizdən Contributor Covenant və ya Vətəndaş Davranış Kodeksini seçməyi təklif edir :

   Birincisini seçirəm və Nəzərdən keçir və Göndər düyməsini klikləyirəm .

   Sonra bu faylı redaktə edə və öhdəsinə götürə bilərsiniz.

   Aşağıda, Birbaşa əsas filiala öhdəçilik et seçimini seçin və Yeni faylı qəbul et üzərinə klikləyin :

   Nəticə olaraq, İcma Profilinə qayıtsaq , Davranış Kodeksinin əlavə edildiyi kimi qeyd olunduğunu görərik :

   Töhfə və Məsələ Şablonu oxşar şəkildə əlavə olunur, ona görə də bunu göstərməyəcəyəm. Özün et ;)

5. Pull Sorğu şablonunu əlavə edin .

   Ancaq bu barədə ayrıca danışacağıq.

   Bilmirəm niyə GitHub Pull-Request şablonunu qurmaq üçün eyni rahat variantı əlavə etməyib, ona görə də sənədləri öyrənib əl ilə əlavə etməli olacaqsınız.

   Bunu etmək üçün, repozitoriyanın kökündə yeni fayl yarat düyməsini basın :

   Fayl adı belə olmalıdır: .github/pull_request_template.md .

   Biz şablona lazım olanı əlavə edirik və yuxarıda etdiyimiz kimi Yeni faylı qəbul et düyməsini klikləyirik. Mən təkəri yenidən kəşf etmək fikrində deyildim və mənə olduqca faydalı görünən bir nümunə tapdım .

   Bu yolla bütün İcma Profili doldurulacaq:

6. Şablon Repository markerini əlavə edin .

   Bunu etmək üçün depoda Parametrlər seçiminə keçin və Şablon Repository dediyi qutuyu işarələyin:

   Və budur, yeni layihələr yaratmaq üçün şablon hazırdır. Beləliklə, gələcəkdə yeni layihələr yaratmaq lazım olanda çox vaxta qənaət edəcəyik. Bu, həm də vacib təfərrüatları qaçırmamağa kömək edəcək, çünki tez-tez bir şey əlavə etməyi unudursunuz, məsələn, lisenziya və ya problem üçün aydın şablon.

Şablon Repozitoriyasından necə istifadə etmək olar

İstifadə üçün iki seçim var:

1. Şablon bilavasitə sizə məxsus olduqda: Yeni repozitoriya yaradarkən sizə sahib olduğunuz şablonlar siyahısından şablondan yaratmaq imkanı veriləcək:

2. Şablon xarici olduqda: burada da heç bir xüsusi problem yoxdur. Həmin şablona keçin və Bu şablondan istifadə et düyməsini klikləyin . Burada rəsmi sənəddəki animasiyadan istifadə edəcəyəm:

Gəlin ümumiləşdirək

Bu yazıda baxdıq:

• GitHub deposu nədir;
• Şablon deposu nədir;
• Şablon anbarında nə olmalıdır;
• Şablon Anbarını necə yaratmaq olar;
• Şablon Repozitoriyasından necə istifadə etmək olar.

Əlbəttə ki, bu şablona əsasən, siz artıq daha konkret olanları yarada bilərsiniz. Məsələn, mən artıq konfiqurasiya edilmiş maven və ya gradle qurma sistemləri ilə daha çox şablon yaratdım. Daha çox: son ikisinə əsaslanaraq Spring Boot Repository Şablonu yarada bilərsiniz. Bütün şablonları qruplaşdırmaq üçün GitHub-da bütün şablonlarla şablon-repozitor təşkilatı yaratdım. GitHub hesabıma abunə olun

faydalı bağlantılar

• Yaratdığım bütün şablonlarla təşkilat
• GitHub Blogu: Repozitor şablonları ilə yeni repozitoriya yaradın, depolar üçün şablon necə yaradılır
• GitHub Yardımı: Repozitoriyaların nə olduğu haqqında depolar haqqında.
• GitHub Yardımı: Şablondan repozitoriyanın yaradılması Şablon əsasında yeni layihənin necə yaradılması
• GitHub Yardımı: Layihələr üçün lisenziyalaşdırmanın repozitor təsvirinin lisenziyalaşdırılması
• GitHub Yardımı: Anbar yaratmaq üçün repo təsvirini yaradın
• Açıq mənbəli layihələrin yaradılması/təsvir edilməsi üçün Açıq Mənbə Bələdçiləri məsləhətləri.
• GitHub Yardımı: çəkmə sorğusu şablonunun əlavə edilməsi - çəkmə sorğuları üçün şablon yaratmaq.

Daha çox məqalələrim

• Intellij IDEA-da debug: yeni başlayanlar üçün bələdçi
• Skyscanner API üçün müştəri yaratmaq və onu jCenter və Maven Central-da dərc etmək üçün bələdçi [1-ci hissə]
• Skyscanner API üçün müştəri yaratmaq və onu jCenter və Maven Central-da dərc etmək üçün bələdçi [2-ci hissə]
• Aviabiletlərin qiymətinə nəzarət sisteminin yaradılması: addım-addım təlimat [1-ci hissə]
• Aviabiletlərin qiymətinə nəzarət sisteminin yaradılması: addım-addım təlimat [2-ci hissə]
• Aviabiletlərin qiymətinə nəzarət sisteminin yaradılması: addım-addım təlimat [3-cü hissə]
• Giriş: nə, necə, harada və nə ilə?
• Müsahibə testi necə açıq mənbəli kitabxanaya çevrildi
• Uğur tarixi. Həftədə 20 saat proqramlaşdırma, magistr dərəcəsi və şəxsi həyat
• Necə iş tapmaq olar? CV göndərmək üçün məsləhətlər