GitHub-та жобаларыңызбен жұмысты оңтайландыру: Github үлгі репозиторийімен танысу

Барлығына сәлем, JavaRush қауымдастығы! Бүгін біз ашық бастапқы code туралы және жазылған codeқа ҚОСЫМША жоғары сапалы жобаны жасау үшін не қажет екенін айтатын боламыз . Пайдалы өнімді жазу маңызды. Бірақ маңыздысы репозиторийдің дұрыс дизайны (GitHub-тағы жоба репозиторийі). Бұл тағы бір маңызды мәселені - өнімді жылжытуды жүзеге асыруға көмектеседі. Жоба өте керемет болса да, бірақ ол нашар жобаланған болса, кем дегенде README-де сипатталмаған болса да (README деген не екенін осы жерден оқи аласыз ), лицензия көрсетілмеген және т.б. және т.б., болады. табыс жоқ. Тек оны ешкім байқамайды. Ал егер біреу байқаса, онымен қалай қарым-қатынас жасау керектігін білмейді. Қайта-қайта толтыруды қажет ететін көптеген нәрселер бар және бағдарламашыға әр уақытта көшіріп, қою оңай емес, және осы жазда GitHub осыған көмектесетін Үлгі репозиторий мүмкіндігін шығарды. Былайша айтқанда, жаңа жобаларды құру процесін автоматтандыру. Бүгін біз репозиторийдің не екенін және үлгі репозиторийінің не екенін түсінеміз. Біз жобада codeтан басқа не болуы керек, қандай нәрселерге назар аудару керек екенін сипаттаймыз. Үлгі репозиторийін нөлден жасайық және менің көзқарасым бойынша қажеттінің бәрін қосамыз. Соңында біз жаңа репозиторий жасау кезінде үлгі репозиторийін қолданамыз. Бірақ алдымен терминдерді түсінейік. Теория: кез келген жобаның жалпы репозиторийінде не болуы керек GitHub жүйесіндегі әрбір ашық бастапқы жобада келесі элементтерді қамтитын жақсы сипатталған Қауымдастық профилі болуы керек.

1. Шығарылым үлгісі

Мұнда репозиторийде мәселені құру ережелерін сипаттау керек: оларды қалай атау керек, қандай белгі болады, оған кім тағайындалады. Жаңа мәселені жасау кезінде келесі опциялар ұсынылады:

• Қате туралы есеп – жобадағы ақауды сипаттау үшін мәселені құру;
• Функция сұранысы – жобаға жаңа идеяны ұсыну;
• Жақсартуға сұраныс – жоба бойынша жетілдіру туралы ұсыныс;
• Теңшелетін мәселе үлгісі - басқа опциялар жұмыс істемесе, бос үлгіні пайдалануға болады.

Бұл қалай көрінетінінің мысалын мына жерден көруге болады .

2. Лицензия

Жоба жазылған лицензия. Бұл жобаны пайдаланатындар ненің кепілдендірілгенін, ненің кепілдік бермейтінін білуі үшін қажет. Мысалы, Apache License 2.0 мынаны айтады:

3.README

Бұл жобаның сипаттамасы, оның визиттік картасы. Жоба туралы айту керек нәрсенің бәрі осында болуы керек. Әрине, оны жобаның ерекшеліктерін ескере отырып, әр жолы сипаттау қажет болады, бірақ тақырыптар бірдей болады. Мысалы:

• Шолу – жобаның қысқаша сипаттамасы;
• Қолдану – жобаны қалай пайдалану керек;
• Ғимарат - жобаны қалай іске қосу керек, бұл үшін не қажет;
• Ақаулықтарды жою - бұл сізде қандай проблемалар туындауы мүмкін екенін және оларды шешу жолын сипаттайды;
• Release Notes - нұсқаға байланысты өзгерістердің сипаттамасы;
• Authorлар - жақындарыңызды ұмытпаңыз;
• Үлес қосу – жобаны әзірлеуге қалай қатыса алатындығыңызды сипаттау;
• Әдеп codeексі – қатысу ережелерін сипаттау;
• RELEASE_NOTES – жаңа нұсқалардың барлық өзгерістері жазылған файл. Мұны бөлек құжатқа салып, сілтемені README ішінде сақтау жақсы тәжірибе;
• CONTRIBUTING — бұл жобаның дамуына қалай үлес қоса алатыныңызды сипаттайтын файл. README ішіндегі Contributing тақырыбы үшін бөлек файл ретінде жасалған;
• CODE_OF_CONDUCT - жобаны әзірлеуге қатысу ережелерін сипаттайтын файл;
• Pull Request үлгісі – тарту сұрауын жасайтындарға арналған үлгі.

Мұның бәрі бағдарламалау тіліне немесе оның ерекшеліктеріне қарамастан жобадан жобаға қолданылады.

Жаттығу: өз шаблоныңызды жасау

Олар айтқандай, сөзден әрекетке көшейік. Енді мысалды қолдана отырып, мен өзіңіздің шаблоныңызды қалай жасау керектігін көрсетемін.

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

2. Жаңа репозиторий жасаңыз: мұны істеу үшін жоғарғы оң жақ бұрыштағы + түймесін басыңыз

3. Жасау кезінде толтырыңыз:

   • Репозиторий атауы - менің жағдайда репозиторий-үлгі;
   • Сипаттама — жобаның қысқаша сипаттамасы;
   • Жеке опцияны таңдауға болады, дегенмен біз Қоғамдық деп қалдырамыз;
   • README инициализациясы жолағын белгілеңіз:

   • Жобаға сәйкес лицензияны таңдаңыз:

     Менің жағдайда үлгі жалпы болғандықтан, gitignore қажет емес: ол белгілі бір жоба мен бағдарламалау тілі үшін қосылады.

     Сондықтан, Репозиторийді жасау түймесін басып , жасау процесін аяқтаңыз. Жүйе бізді автоматты түрде жаңадан жасалған репозиторийге апарады.

4. Қауымдастық профилін толтыру : жасалған репозиторийде Insights қойындысына өтіп, Қауымдастық тармағын таңдаңыз :

   Көріп отырғаныңыздай, тәртіп codeексін, үлес қосуды, шығару үлгісін, тарту сұрау үлгісін толтыру ғана қалады.

   Мысал ретінде мінез-құлық codeексін пайдалана отырып, біз оларды жобаға қалай қосу керектігін көрсетеміз.

   Қосу түймесін басыңыз , жүйе сізге Contributor Covenant немесе Азаматтық мінез-құлық codeексін таңдауды ұсынады :

   Біріншісін таңдап, Қарап шығу және жіберу түймесін басыңыз .

   Одан кейін бұл файлды өңдеуге және оны орындауға болады.

   Төменгі жағында тікелей негізгі бөлімшеге тапсыру опциясын таңдап, Жаңа файлды қабылдау түймесін басыңыз :

   Нәтижесінде, Қауымдастық профиліне қайта оралсақ, Әдеп codeексі қосылған деп белгіленгенін көреміз :

   Үлес қосу және шығару үлгісі ұқсас жолмен қосылған, сондықтан мен оны көрсетпеймін. Өзің жаса ;)

5. Тарту сұрау үлгісін қосыңыз .

   Бірақ біз бұл туралы бөлек айтамыз.

   Мен GitHub неге Pull-Request үлгісін орнату үшін бірдей қолайлы опцияны қоспағанын білмеймін, сондықтан құжаттаманы зерттеп , оны қолмен қосу керек.

   Мұны істеу үшін репозиторийдің түбірінде Жаңа файл жасау түймесін басыңыз :

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

   Үлгіге қажет нәрсені қосамыз және жоғарыда жасағанымыздай, Жаңа файлды орындау түймесін басыңыз. Мен дөңгелекті қайта ойлап тапқым келмеді және маған өте қолайлы болып көрінетін мысал таптым .

   Осылайша бүкіл Қауымдастық профилі толтырылады:

6. Үлгі репозиторийінің маркерін қосыңыз .

   Мұны істеу үшін репозиторийдегі Параметрлер опциясына өтіп , Үлгі репозиторийі жазылған құсбелгіні қойыңыз:

   Міне, жаңа жобаларды құруға арналған үлгі дайын. Осылайша, біз болашақта жаңа жобаларды жасау қажет болғанда көп уақытты үнемдейміз. Бұл сондай-ақ маңызды мәліметтерді жіберіп алмауға көмектеседі, өйткені сіз бірдеңе қосуды ұмытып қаласыз, мысалы, лицензия немесе мәселенің анық үлгісі.

Үлгі репозиторийін пайдалану жолы

Пайдаланудың екі нұсқасы бар:

1. Үлгі сізге тікелей тиесілі болған кезде: Жаңа репозиторий жасаған кезде сізге иелік ететін үлгілер тізімінен үлгіден жасау мүмкіндігі беріледі:

2. Үлгі шетелдік болған кезде: мұнда да ерекше проблемалар жоқ. Сол үлгіге өтіп, Осы үлгіні пайдалану түймесін басыңыз . Мұнда мен ресми құжаттағы анимацияны қолданамын:

Жинақтау

Бұл мақалада біз қарастырдық:

• GitHub репозиторийі дегеніміз не;
• үлгі репозиторийі дегеніміз не;
• Үлгі репозиторийінде не болуы керек;
• шаблон репозиторийін құру жолы;
• Үлгі репозиторийін қалай пайдалану керек.

Әрине, осы үлгінің негізінде сіз нақтырақ үлгілерді жасай аласыз. Мысалы, мен конфигурацияланған maven немесе gradle құрастыру жүйелерімен көбірек үлгілерді жасадым. Қосымша: соңғы екеуіне негізделген Spring Boot репозиторий үлгісін жасауға болады. Барлық үлгілерді топтастыру үшін мен 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-бөлім]
• Ағаш кесу: немен, қалай, қайда және немен?
• Әңгімелесу тесті қалай ашық бастапқы кітапханаға айналды
• Табыс тарихы. Аптасына 20 сағат бағдарламалау, магистратура және жеке өмір
• Жұмысты қалай табуға болады? Түйіндемені жіберуге арналған кеңестер