GitHubдагы долбоорлоруңуз менен иштөөнү оптималдаштыруу: Github Template Repository менен таанышуу

Баарына салам, JavaRush коомчулугу! Бүгүн биз ачык булак жөнүндө жана жазылган codeго КОШУМЧА жогорку сапаттагы долбоорду түзүү үчүн эмне кылуу керектиги жөнүндө сүйлөшөбүз . Бул пайдалуу продукт жазуу маанилүү. Бирок андан кем эмес маанилүү репозиторийдин туура дизайны (GitHubдагы долбоордун репозиторийи). Бул дагы бир негизги пунктту ишке ашырууга жардам берет - продукт жылдыруу. Долбоор супер сонун болсо да, бирок ал начар иштелип чыккан болсо, жок дегенде READMEде сүрөттөлгөн эмес (README деген эмне экенин бул жерден окуй аласыз ), лицензия көрсөтүлгөн эмес, ж.б.у.с. ийгorк жок. Болгону аны эч ким байкаbyte. Ал эми кимдир бирөө байкап калса, аны менен кантип иштешүүнү билбей калат. Кайра-кайра толтурулушу керек болгон көп нерселер бар жана программист үчүн ар бир жолу көчүрүп, чаптоо оңой эмес, бул үчүн ушул жайда GitHub буга жардам берген Template Repository функциясын чыгарды . Мындайча айтканда, жаңы долбоорлорду түзүү процессин автоматташтыруу. Бүгүн биз репозиторий эмне экенин жана шаблондук репозиторий эмне экенин түшүнөбүз. Биз долбоордо codeдон башка эмне болушу керек экенин, кайсы нерселерге көңүл буруу керек экенин сүрөттөп беребиз. Келгиле, нөлдөн баштап Template Repository түзөлү жана менин көз карашым боюнча керектүү нерселердин баарын кошолу. Акыр-аягы, биз жаңы репозиторийди түзүүдө Template Repository колдонобуз. Бирок адегенде терминдерди түшүнүп алалы. Теория: кандайдыр бир долбоордун жалпы репозиторийинде эмне болушу керек GitHubдагы ар бир ачык булактуу долбоор төмөнкү элементтерди камтыган жакшы сүрөттөлгөн Коомчулук профorне ээ болушу керек.

1. Чыгарылган үлгү

Бул жерде сиз репозиторийде маселени түзүү эрежелерин сүрөттөп беришиңиз керек: аларды эмне деп аташ керек, энбелгиси кандай болот, ага ким дайындалат. Жаңы маселени түзүүдө төмөнкү опциялар сунушталат:

• Мүчүлүштүктөр жөнүндө отчет - долбоордогу кемчorкти сыпаттоо үчүн маселени түзүү;
• Функция суроо-талабы - долбоор үчүн жаңы идеяны сунуштоо;
• Өркүндөтүү өтүнүчү - долбоор боюнча жакшыртуу боюнча сунуш;
• Ыңгайлаштырылган маселе үлгүсү - башка параметрлер иштебесе, сиз бош шаблонду колдонсоңуз болот.

Бул кандайча көрүнгөнүнүн мисалын бул жерден көрүүгө болот .

2. Лицензия

Долбоор жазылган лицензия. Долбоорду колдоно тургандар эмнеге кепилдик бар жана эмнеге кепилдик жок экенин бorши үчүн зарыл. Мисалы, Apache License 2.0 төмөнкүлөрдү айтат:

3.README

Бул долбоордун сүрөттөлүшү, анын визиттик картасы. Долбоор жөнүндө айта турган нерселердин баары ушул жерде болушу керек. Албетте, ал долбоордун өзгөчөлүгүн эске алуу менен ар бир жолу сүрөттөлүшү керек болот, бирок рубрикалар бирдей болот. Мисалы:

• Обзор - долбоордун кыскача баяндамасы;
• Колдонуу - долбоорду кантип колдонуу керек;
• Building - долбоорду кантип ишке киргизүү керек, бул үчүн эмне керек;
• Мүчүлүштүктөрдү аныктоо - бул сиз кандай көйгөйлөргө туш болушуңуз мүмкүн экенин жана аларды кантип чечүү керектигин сүрөттөйт;
• Release Notes - versionга жараша өзгөрүүлөрдүн сүрөттөлүшү;
• Authorлор - жакындарыңызды унутпаңыз;
• Салым кошуу - долбоорду иштеп чыгууга кантип катыша аларыңыздын сыпаттамасы;
• Жүрүм-турум codeекси - катышуу эрежелеринин сүрөттөлүшү;
• RELEASE_NOTES - жаңы versionлар үчүн бардык өзгөртүүлөр жазылган файл. Муну өзүнчө documentке салып, шилтемени READMEде сактоо жакшы практика;
• CONTRIBUTING – бул долбоордун өнүгүшүнө кантип салым кошо аларыңызды сүрөттөгөн файл. README ичиндеги Contributing аталышы үчүн өзүнчө файл катары жасалган;
• КОДЕКС_ЖҮРҮМ - долбоорду иштеп чыгууга катышуу эрежелерин сүрөттөгөн файл;
• Pull Request үлгүсү - тартуу суроо-талапты түзө тургандар үчүн шаблон.

Мунун баары программалоо тorне же анын өзгөчөлүктөрүнө карабастан, долбоордон долбоорго колдонулат.

Көнүгүү: өзүңүздүн шаблонуңузду түзүү

Алар айткандай, сөздөн ишке өтөлү. Эми, бир мисал колдонуп, мен сизге өзүңүздүн шаблонуңузду кантип түзүүнү көрсөтөм.

1. Сизге керек болгон биринчи нерсе - GitHub аккаунту / ошол жерден катталуу .

2. Жаңы репозиторий түзүү: бул үчүн, жогорку оң бурчтагы + баскычын чыкылдатыңыз

3. Түзүүдө төмөнкүнү толтуруңуз:

   • Репозиторийдин аталышы - менин учурда репозиторий-шаблон;
   • Description — долбоордун кыскача баяндамасы;
   • Сиз Купуяны тандасаңыз да, биз Жалпыга ачыктан чыгабыз;
   • README баштоо кутучасын белгилеңиз:

   • Долбоор боло турган лицензияны тандаңыз:

     Менин учурда шаблон жалпы болгондуктан, gitignore кереги жок: ал белгилүү бир долбоор жана программалоо тor үчүн кошулат.

     Ошондуктан, чыкылдатыңыз Репозиторий түзүү , ошону менен түзүү процессин аяктайт. Система бизди автоматтык түрдө жаңы түзүлгөн репозиторийге алып барат.

4. Коомдоштук профorн толтуруу : түзүлгөн репозиторийде Insights өтмөгүнө өтүп, Коомчулукту тандаңыз :

   Көрүнүп тургандай, жүрүм-турум codeексин, салым кошуу, чыгаруу шаблонун, тартуу өтүнүчүнүн шаблонун толтуруу гана калды.

   Жүрүм-турум codeексин мисал катары колдонуп, биз аларды долбоорго кантип кошууну көрсөтөбүз.

   Кошууну чыкылдатыңыз , система сизден Contributor Covenant же Жарандык жүрүм-турум codeексин тандоону сунуштайт :

   Мен биринчисин тандап, Карап чыгуу жана тапшырууну басыңыз .

   Андан кийин, сиз бул файлды түзөтүп, аны аткара аласыз.

   Төмөндө, түздөн-түз башкы фorалга тапшыруу опциясын тандап, Жаңы файлды тапшырууну чыкылдатыңыз :

   Натыйжада, эгер Коомчулуктун профorне кайтып барсак, Жүрүм-турум Кодекси кошулган деп белгиленгенин көрөбүз :

   Салым кошуу жана чыгаруу үлгүсү окшош жол менен кошулган, ошондуктан мен муну көрсөтпөйм. Өзүң кыл;)

5. Тартуу өтүнүчүнүн шаблонун кошуу .

   Бирок биз бул тууралуу өзүнчө сүйлөшөбүз.

   Мен GitHub эмне үчүн Pull-Request үлгүсүн орнотуу үчүн бирдей ыңгайлуу вариантты кошпогондугун билбейм, андыктан сиз documentтерди изилдеп , аны кол менен кошушуңуз керек болот.

   Бул үчүн, репозиторийдин тамырында жаңы файл түзүү баскычын чыкылдатыңыз :

   Файлдын аталышы болушу керек: .github/pull_request_template.md .

   Биз шаблонго керектүү нерселерди кошуп, жогоруда айткандай, Жаңы файлды тапшырууну басыңыз. Мен дөңгөлөктү кайра ойлоп тапкысы келген жокмун жана мага абдан ыңгайлуу көрүнгөн мисалды таптым .

   Ошентип, Коомчулуктун профor толугу менен толтурулат:

6. Үлгү репозиторийинин маркерин кошуңуз .

   Бул үчүн, репозиторийдеги Орнотуулар опциясына өтүп , Template Repository деп жазылган кутучаны белгилеңиз:

   Мына ушундай, жаңы долбоорлорду түзүү үчүн шаблон даяр. Ошентип, биз келечекте жаңы долбоорлорду түзүү керек болгондо көп убакытты үнөмдөйбүз. Бул ошондой эле маанилүү деталдарды өткөрүп жибербөөгө жардам берет, анткени сиз көп учурда бир нерсе кошууну унутуп каласыз, мисалы, лицензия же маселе үчүн ачык шаблон.

Template Repository кантип колдонсо болот

Колдонуунун эки варианты бар:

1. Шаблон түздөн-түз сизге таандык болгондо: Жаңы репозиторийди түзүп жатканда, сизге таандык калыптардын тизмесинен калыптан түзүү мүмкүнчүлүгү берилет:

2. Шаблон чет өлкөлүк болгондо: бул жерде да өзгөчө көйгөйлөр жок. Ошол калыпка өтүп, Бул шаблонду колдонуу баскычын чыкылдатыңыз . Бул жерде мен расмий documentтин анимациясын колдоном:

Жыйынтыктап көрөлү

Бул макалада биз карап:

• GitHub репозиторий деген эмне;
• Template repository деген эмне;
• Template репозиторийинде эмне болушу керек;
• шаблон репозиторийди кантип түзүү керек;
• Template Repository кантип колдонуу керек.

Албетте, бул шаблондун негизинде, сиз буга чейин дагы конкреттүүлөрдү түзө аласыз. Мисалы, мен буга чейин конфигурацияланган maven же gradle куруу системалары менен көбүрөөк шаблондорду түздүм. Дагы: акыркы экөөнүн негизинде жазгы жүктөө репозиторийинин шаблонун түзө аласыз. Бардык калыптарды топтош үчүн, мен GitHubда бардык шаблондор менен шаблон-репозиторий уюмун түздүм. Менин GitHub аккаунтума жазылыңыз

пайдалуу шилтемелер

• Мен түзгөн бардык шаблондор менен уюм
• GitHub блогу: Репозиторийлердин шаблондору менен жаңы репозиторийлерди жаратыңыз, репозиторийлер үчүн шаблонду кантип түзүү керек
• GitHub Жардамы: Репозиторийлер жөнүндө репозиторийлер жөнүндө.
• GitHub Жардамы: Калыптан репозиторий түзүү, шаблондун негизинде жаңы долбоорду кантип түзүү керек
• GitHub Жардам: Долбоорлор үчүн лицензиялоо репозиторийинин сүрөттөмөсүн лицензиялоо
• GitHub Жардамы: Репозиторийди түзүүнүн репо сүрөттөмөсүн түзүңүз
• Open Source Guides ачык булактуу долбоорлорду түзүү/сүрөттөө боюнча кеңештер.
• GitHub Жардамы: тартуу сурамынын шаблонун кошуу - тартуу сурамдары үчүн шаблон түзүү.

Менин макалаларымдын көбүрөөк

• Intellij IDEAдагы мүчүлүштүктөрдү оңдоо: үйрөнчүктөр үчүн колдонмо
• Skyscanner API үчүн кардар түзүү жана аны jCenter жана Maven Centralда жарыялоо боюнча колдонмо [1-бөлүк]
• Skyscanner API үчүн кардарды түзүү жана аны jCenter жана Maven Centralда жарыялоо боюнча колдонмо [2-бөлүк]
• Авиа билеттерине баа мониторинг системасын түзүү: кадам-кадам колдонмо [1-бөлүк]
• Авиа билеттерине баа мониторинг системасын түзүү: кадам-кадам колдонмо [2-бөлүк]
• Авиа билеттерине баа мониторинг системасын түзүү: кадам-кадам колдонмо [3-бөлүк]
• Кароол: эмне, кантип, кайда жана эмне менен?
• Кантип интервью тести ачык булак китепканасына айланган
• Ийгorктин тарыхы. Жумасына 20 саат программалоо, магистр даражасы жана жеке жашоо
• Кантип жумуш тапса болот? Резюме жөнөтүү боюнча кеңештер