GitHub-daky taslamalaryňyz bilen işi optimizirlemek: Github şablon ammary bilen tanyşmak

Hemmelere salam, JavaRush jemgyýeti! Bu gün açyk çeşme we ýazylan koda GOŞMAÇA ýokary hilli taslama döretmek üçin nämeler gerekdigi barada gürleşeris . Peýdaly önüm ýazmak möhümdir. Emma ammaryň dogry dizaýny (GitHub-daky taslama ammary) möhümdir. Bu başga bir möhüm nokady - önümi mahabatlandyrmaga kömek eder. Taslama gaty ajaýyp bolsa-da, erbet işlenmedik bolsa, iň bolmanda README-de beýan edilmese (README-iň nämedigini şu ýerde okap bilersiňiz ), ygtyýarnama görkezilmeýär we ş.m. üstünlik ýok. Diňe hiç kim ony duýmaz. Kimdir biri duýsa, onuň bilen nähili aragatnaşyk saklamalydygyny bilmezler. Gaýtadan doldurylmaly köp zat bar, programmistiň her gezek göçürip almagy aňsat däl we diňe şu tomus GitHub bu meselede kömek edýän Şablon ammary aýratynlygyny çykardy. Diýmek, täze taslamalary döretmek prosesini awtomatlaşdyrmak. Bu gün Ammaryň nämedigini we Şablon ammarynyň nämedigine düşüneris. Taslamada koddan başga näme bolmalydygyny, haýsy zatlara üns bermelidigini düşündireris. Geliň, Şablon ammaryny noldan döredeliň we meniň pikirimçe zerur zatlary goşalyň. Netijede, täze ammar döredilende Şablon ammaryny ulanarys. Emma ilki bilen adalgalara düşüneliň. Nazaryýet: Islendik taslamanyň umumy ammarynda näme bolmaly GitHub-daky her açyk çeşme taslamasynda aşakdaky elementleri öz içine alýan gowy suratlandyrylan Jemgyýetçilik Profili bolmaly .

1. Şablon çykarmak

Bu ýerde ammarda bir mesele döretmegiň düzgünlerini suratlandyrmaly: olara näme diýilmelidigi, belligiň nähili boljakdygy, kime beriljekdigi. Täze mesele döredilende aşakdaky wariantlar hödürlener:

• Bug hasabaty - taslamadaky kemçiligi suratlandyrmak üçin bir mesele döretmek;
• Aýratynlyk haýyşy - taslama üçin täze ideýanyň teklibi;
• Gowulaşdyrmak haýyşy - taslamany gowulandyrmak baradaky teklip;
• Issueörite mesele şablony - başga opsiýalar işlemese, boş şablony ulanyp bilersiňiz.

Görnüşiniň mysalyny şu ýerden görüp bilersiňiz .

2. Ygtyýarnama

Taslamanyň ýazylan ygtyýarnamasy. Taslamany ulanjaklar nämäniň kepillendirilendigini we nämäniň ýokdugyny bilmegi üçin zerurdyr. Mysal üçin, Apache Ygtyýarnamasy 2.0 aşakdakylary aýdýar:

3.README

Bu taslamanyň beýany, jaň kartasy. Taslama barada aýdylmaly zatlaryň hemmesi şu ýerde bolmaly. Elbetde, taslamanyň aýratynlyklaryny göz öňünde tutup, her gezek beýan edilmeli, ýöne sözbaşylar birmeňzeş bolar. Mysal üçin:

• Gysgaça syn - taslamanyň gysgaça beýany;
• Ulanylyşy - taslamany nädip ulanmaly;
• Gurluşyk - taslamany nädip başlamaly, munuň üçin zerur zat;
• Näsazlyklary düzetmek - bu haýsy meselelere duş geljekdigiňizi we olary nädip çözmelidigini düşündirýär;
• Çykyş bellikleri - wersiýa baglylykda üýtgeşmeleriň beýany;
• Uthorsazyjylar - ýakynlaryňyzy ýatdan çykarmaň;
• Goşant goşmak - taslamanyň ösüşine nädip gatnaşyp boljakdygyňyzyň beýany;
• Özüňi alyp baryş şertleri - gatnaşmagyň düzgünleriniň beýany;
• RELEASE_NOTES - täze wersiýalar üçin ähli üýtgeşmeleriň ýazylan faýly. Muny aýratyn resminama salmak we README-de baglanyşyk saklamak gowy tejribe;
• GÖRNÜŞ bu taslamanyň ösüşine nähili goşant goşup biljekdigiňizi görkezýän faýl. README-de Goşant goşýan sözbaşy üçin aýratyn faýl hökmünde ýasaldy;
• CODE_OF_CONDUCT - taslamanyň ösüşine gatnaşmagyň düzgünlerini beýan edýän faýl;
• Pull Request şablony - çekiş haýyşyny döredýänler üçin şablon.

Bu zatlaryň hemmesi programmirleme diline ýa-da aýratynlyklaryna garamazdan taslamadan taslama çenli ulanylýar.

Amaly: öz şablonyňyzy döretmek

Olaryň aýdyşy ýaly, geliň sözlerden herekete geçeliň. Indi, bir mysal ulanyp, öz şablonyňyzy nädip döretmelidigini görkezerin.

1. Ilki bilen size GitHub-daky hasap / şol ýerde hasaba alyň .

2. Täze ammar dörediň: muny etmek üçin ýokarky sag burçda + basyň

3. Döredilende:

   • Ammaryň ady - meniň ýagdaýymda ammar-şablon;
   • Düşündiriş - taslamanyň gysgaça beýany;
   • Hususy saýlap bilersiňiz, köpçülikden çykýarys;
   • README başlangyç gutusyny belläň:

   • Taslamanyň boljak ygtyýarnamasyny saýlaň:

     Meniň ýagdaýymda şablon umumy bolansoň, gitignore zerur däl: belli bir taslama we programmirleme dili üçin goşular.

     Şonuň üçin ammar döretmek düwmesine basyň we şeýlelik bilen dörediş işini tamamlaň. Ulgam bizi awtomatiki usulda täze döredilen ammarlara alyp barar.

4. Jemgyýetiň profilini doldurmak : döredilen ammarda “Düşündirişler” goýmasyna giriň we Jemgyýeti saýlaň :

   Görşüňiz ýaly, galan zat Özüňi alyp barmak, goşant goşmak, çykarmak şablony, haýyş haýyşyny doldurmak.

   Özüňi alyp baryş şertleriniň mysalyny ulanyp, olary nädip taslama goşmalydygyny görkezeris.

   Goşmak düwmesine basyň , ulgam size Goşant goşýan şertnamany ýa-da raýatlaryň özüni alyp baryş şertlerini saýlamagy maslahat berýär :

   Birinjisini saýlaýaryn we Syn we Ibermek düwmesine basýaryn .

   Ondan soň, bu faýly redaktirläp we ýerine ýetirip bilersiňiz.

   Aşakda, esasy şahanyň opsiýasyna gönüden-göni borçnamany saýlaň we täze faýly basyň :

   Netijede, jemgyýetçilik profiline gaýdyp gelsek, Özüňi alyp baryş şertleriniň goşulan ýaly bellik edilendigini göreris :

   Goşant goşmak we çykarmak şablony şuňa meňzeş görnüşde goşuldy, şonuň üçin görkezmerin. Özüň et ;)

5. Pull Request şablonyny goşuň .

   Emma bu barada aýratyn gürleşeris.

   GitHub-yň näme üçin Pull-Request şablonyny gurmak üçin şol bir amatly warianty goşmaýandygyny bilemok, şonuň üçin resminamalary öwrenmeli we el bilen goşmaly bolarsyňyz.

   Munuň üçin ammaryň kökünde täze faýl döretmek düwmesine basyň :

   Faýlyň ady: .github / pull_request_template.md bolmaly .

   Şablona zerur zatlary goşýarys we ýokardaky ýaly edişimiz ýaly täze faýl basyň . Tigiri täzeden açjak bolamokdym we maňa gaty peýdaly bir mysal tapdym .

   Şeýlelik bilen, ähli jemgyýetçilik profilini doldurarlar:

6. Şablon ammar belligini goşuň .

   Munuň üçin ammardaky Sazlamalar opsiýasyna giriň we Şablon ammary diýilýän gutujygy belläň:

   Ine, täze taslamalary döretmek üçin şablon taýýar. Şeýlelik bilen, geljekde täze taslamalary döretmeli bolanymyzda köp wagt tygşytlarys. Bu, şeýle hem möhüm jikme-jiklikleri ýitirmezlige kömek eder, sebäbi köplenç bir zat goşmagy ýatdan çykarsaňyz, mysal üçin ygtyýarnama ýa-da bir mesele üçin açyk şablon.

Şablon ammaryny nädip ulanmaly

Ulanmak üçin iki wariant bar:

1. Şablon gönüden-göni size degişli bolsa: Täze ammar döredilende, size galyplaryň sanawyndan bir şablondan döretmek mümkinçiligi berler:

2. Şablon daşary ýurt bolanda: bu ýerde-de aýratyn problema ýok. Şol şablona gidiň we bu şablony ulanmak düwmesine basyň . Bu ýerde resmi dokumentdäki animasiýany ulanaryn:

Geliň, jemläliň

Bu makalada biz seretdik:

• GitHub ammary näme?
• Şablon ammary näme?
• Şablon ammarynda näme bolmaly;
• Şablon ammaryny nädip döretmeli;
• Şablon ammaryny nädip ulanmaly.

Elbetde, bu şablona esaslanyp, has anyklaryny döredip bilersiňiz. Mysal üçin, eýýäm düzülen maven ýa-da gradle gurluş ulgamlary bilen has köp şablon döretdim . Has giňişleýin: soňky ikisine esaslanyp, “Bahar boot” ammar şablonyny döredip bilersiňiz. Allhli galyplary toparlamak üçin, ähli şablonlar bilen GitHub-da şablon-ammar guramasyny döretdim. GitHub hasabyma ýazylyň

peýdaly baglanyşyklar

• Döreden ähli galyplarym bilen gurama
• GitHub blogy: Ammarlar üçin şablon nädip döredip boljakdygyny ammar şablonlary bilen täze ammar dörediň
• GitHub Kömek: Ammarlaryň nämedigi barada ammarlar hakda.
• GitHub Kömek: Şablona esaslanýan täze taslamany nädip döredip boljakdygyny şablondan ammar döretmek
• GitHub Kömek: Taslamalar üçin ygtyýarnamanyň ammar düşündirişini ygtyýarlandyrmak
• GitHub Kömek: Ammar döretmegiň repo beýanyny dörediň
• Açyk çeşme taslamalaryny döretmek / beýan etmek üçin açyk çeşme gollanmalary .
• GitHub Kömek: çekmek haýyşy şablonyny goşmak - çekmek haýyşlary üçin şablon döretmek.

Makalalarymyň köpüsi

• Intellij IDEA-da düzediş: täze başlanlar üçin gollanma
• Skyscanner API üçin müşderi döretmek we ony jCenter we Maven Central-da neşir etmek üçin gollanma [1-nji bölüm]
• Skyscanner API üçin müşderi döretmek we ony jCenter we Maven Central-da neşir etmek üçin gollanma [2-nji bölüm]
• Howa biletleriniň bahasyna gözegçilik ulgamyny döretmek: ädimme-ädim gollanma [1-nji bölüm]
• Howa biletleriniň bahasyna gözegçilik ulgamyny döretmek: ädimme-ädim gollanma [2-nji bölüm]
• Howa biletleriniň bahasyna gözegçilik ulgamyny döretmek: ädimme-ädim gollanma [3-nji bölüm]
• Gingurnal: näme, nädip, nirede we näme bilen?
• Söhbetdeşlik synagy nädip açyk çeşme kitaphanasyna öwrüldi
• Üstünligiň taryhy. Hepdede 20 sagat programmirleme, magistr derejesi we şahsy durmuş
• Iş tapmaly? Rezýume ibermek üçin maslahatlar