Оптимизатсияи кор бо лоиҳаҳои худ дар GitHub: шиносоӣ бо анбори Шаблонҳои Github

Салом ба ҳама, ҷомеаи JavaRush! Имрӯз мо дар бораи манбаи кушода сӯҳбат хоҳем кард ва барои сохтани лоиҳаи баландсифат БАР ҒАЙР аз рамзи навишташуда чӣ лозим аст. Навиштани маҳсулоти муфид муҳим аст. Аммо тарҳи дурусти анбор (анбори лоиҳа дар GitHub) муҳим нест. Ин барои ба амал баровардани боз як нуктаи асосй — пешбурди махсулот ёрй мерасонад. Ҳатто агар лоиҳа хеле олиҷаноб бошад ҳам, аммо агар он суст тарҳрезӣ шуда бошад, ҳадди аққал дар README тавсиф карда нашудааст (шумо метавонед дар бораи он ки README чист дар ин ҷо хонед ), литсензия нишон дода нашудааст ва ғайра ва ғайра. муваффакият нест. Фақат ин аст, ки касе ӯро пайхас намекунад. Ва агар касе пайхас кунад, онҳо намедонанд, ки бо ӯ чӣ гуна муносибат кунанд. Чизҳои зиёде ҳастанд, ки бояд такрор ба такрор пур карда шаванд ва ҳар дафъа нусхабардорӣ ва часбондан барои барномасоз осон нест ва маҳз барои ин, дар ин тобистон, GitHub хусусияти Шаблон анбориро баровард , ки ба ин кӯмак мекунад. Агар гуем, автоматй кунондани процесси сохтани лоихахои нав. Имрӯз мо мефаҳмем, ки репозиторий чист ва анбори Шаблон чист. Мо тавсиф хоҳем кард, ки ба ғайр аз code дар лоиҳа чӣ бояд бошад, ба кадом чизҳо диққат додан лозим аст. Биёед як анбори Шаблонро аз сифр созем ва ҳама чизро аз нуқтаи назари ман илова кунем. Ва ниҳоят, мо ҳангоми сохтани анбори нав анбори Шаблонро истифода хоҳем бурд. Аммо аввал биёед шартҳоро фаҳмем. Назария: дар анбори умумии ҳама гуна лоиҳа чӣ бояд бошад Ҳар як лоиҳаи кушодаасос дар GitHub бояд профor хуб тавсифшудаи ҷомеа дошта бошад , ки унсурҳои зеринро дар бар мегирад.

1. Шаблони нашр

Дар ин ҷо шумо бояд қоидаҳои эҷоди масъаларо дар репозиторий тавсиф кунед: онҳо бояд чӣ ном шаванд, нишона чӣ гуна хоҳад буд, ба он кӣ таъин карда мешавад. Ҳангоми эҷод кардани шумораи нав, имконоти зерин пешниҳод карда мешаванд:

• Ҳисобот оид ба хатогиҳо - эҷод кардани масъала барои тавсифи камбудиҳо дар лоиҳа;
• Дархости хусусият - пешниҳоди идеяи нав барои лоиҳа;
• дархост оид ба такмил – пешниҳод оид ба такмor лоиҳа;
• Шаблони масъалаи фармоишӣ - агар имконоти дигар кор накунанд, шумо метавонед қолаби холӣ истифода баред.

Намунаи он чӣ гуна ба назар мерасад, дар ин ҷо дида мешавад .

2. Иҷозатнома

Иҷозатнома, ки дар он лоиҳа навишта шудааст. Зарур аст, ки онҳое, ки лоиҳаро истифода мебаранд, бидонанд, ки чӣ кафолат дорад ва чӣ не. Масалан, License 2.0 Apache инҳоро мегӯяд:

3. README

Ин аст тавсифи лоиҳа, корти занги он. Ҳама чизеро, ки дар бораи лоиҳа гуфтан лозим аст, бояд дар ин ҷо бошад. Албатта, онро хар дафъа бо назардошти хусусиятхои лоиха тавсиф кардан лозим меояд, вале сарлавхахо як хел хоханд буд. Барои намуна:

• Тафсири мухтасар - тавсифи мухтасари лоиҳа;
• Истифода - чӣ тавр истифода бурдани лоиҳа;
• Бино - чӣ гуна бояд лоиҳаро оғоз кард, барои ин чӣ лозим аст;
• Бартараф кардани мушкилот - ин тавсиф мекунад, ки шумо бо кадом мушкилот дучор мешавед ва чӣ гуна онҳоро ҳал кунед;
• Эзоҳҳои нашр - тавсифи тағирот вобаста ба version;
• Муаллифон - дар бораи наздикони худ фаромӯш накунед;
• Саҳмгузорӣ - тавсифи он, ки чӣ гуна шумо метавонед дар таҳияи лоиҳа иштирок кунед;
• Кодекси рафтор - тавсифи қоидаҳои иштирок;
• RELEASE_NOTES - файле, ки дар он ҳама тағйирот барои versionҳои нав сабт карда мешаванд. Ин як таҷрибаи хубест, ки инро дар ҳуҷҷати алоҳида ҷойгир кунед ва истинодро дар README нигоҳ доред;
• ҲИССА ДОДАНИ файлест, ки тасвир мекунад, ки чӣ гуна шумо метавонед дар рушди ин лоиҳа саҳм гузоред. Ҳамчун файли алоҳида барои сарлавҳаи Contributing дар README сохта шудааст;
• КАМЗИ_РАФТОР - файле, ки қоидаҳои иштирок дар таҳияи лоиҳаро тавсиф мекунад;
• Шаблони дархости кашолакунӣ - қолаб барои онҳое, ки дархости кашиданро эҷод мекунанд.

Ҳамаи ин чизҳо новобаста аз забони барномасозӣ ва хусусиятҳои он аз лоиҳа ба лоиҳа истифода мешаванд.

Амал: сохтани қолаби шахсии худ

Чунон ки мегуянд, аз сухан ба амал мегузарем. Ҳоло, бо истифода аз як мисол, ман ба шумо нишон медиҳам, ки чӣ гуна қолаби шахсии худро эҷод кунед.

1. Аввалин чизе, ки ба шумо лозим аст, ин ҳисоб дар GitHub аст / дар он ҷо сабти ном кунед .

2. Анбори нав эҷод кунед: барои ин, + -ро дар кунҷи рости болои клик кунед

3. Ҳангоми эҷод, пур кунед:

   • Номи анбор - дар ҳолати ман репозиторий-шаблон;
   • Тавсиф — тавсифи мухтасари лоиҳа;
   • Мо ҷамъиятро тарк мекунем, гарчанде шумо метавонед Хусусиро интихоб кунед;
   • Қуттии оғозкунии README-ро санҷед:

   • Литсензияеро интихоб кунед, ки зери он лоиҳа хоҳад буд:

     Азбаски дар ҳолати ман қолаб умумӣ аст, gitignore лозим нест: он барои як лоиҳаи мушаххас ва забони барномасозӣ илова карда мешавад.

     Аз ин рӯ, Эҷоди анбор ро пахш кунед ва бо ин васила раванди эҷодро анҷом диҳед. Система моро ба таври худкор ба анбори навтаъсис мебарад.

4. Пур кардани профor ҷомеа : дар анбори сохташуда, ба ҷадвали фаҳмишҳо гузаред ва Ҷамъиятро интихоб кунед :

   Тавре ки шумо мебинед, танҳо пур кардани Кодекси рафтор, саҳмгузорӣ, қолаби масъала, қолаби дархости кашидан боқӣ мемонад.

   Бо истифода аз мисоли Кодекси рафтор мо нишон медиҳем, ки чӣ тавр онҳоро ба лоиҳа илова кардан мумкин аст.

   Иловаро пахш кунед , система аз шумо хоҳиш мекунад, ки Аҳдномаи саҳмгузор ё Кодекси рафтори шаҳрвандиро интихоб кунед :

   Ман аввалинашро интихоб мекунам ва Баррасӣ ва Ирсол -ро пахш мекунам .

   Баъдан, шумо метавонед ин файлро таҳрир кунед ва онро иҷро кунед.

   Дар поён, интихоби бевосита ба фorали асосӣ супурданро интихоб кунед ва "Файли нав" -ро клик кунед :

   Дар натиҷа, агар мо ба Профor ҷомеа баргардем , мо мебинем, ки Кодекси рафтор ҳамчун иловашуда қайд карда шудааст:

   Шаблони саҳмгузорӣ ва нашр ба ҳамин тарз илова карда шудаанд, бинобар ин ман инро нишон намедиҳам. Инро худат кунед;)

5. Иловаи Шаблон дархости кашидан .

   Аммо биёед дар ин бора алохида сухан ронем.

   Ман намедонам, ки чаро GitHub як варианти мувофиқро барои насб кардани қолаби Pull-Request илова накардааст, аз ин рӯ шумо бояд ҳуҷҷатҳоро омӯзед ва онро дастӣ илова кунед.

   Барои ин, клик кунед Сохтани файли нав дар решаи анбор :

   Номи файл бояд чунин бошад: .github/pull_request_template.md .

   Мо ба қолаб он чизеро, ки ба мо лозим аст, илова мекунем ва "Файли нав" -ро пахш мекунем , тавре ки мо дар боло кардем. Ман чархро аз нав ихтироъ карданӣ набудам ва намунае пайдо кардам , ки ба назари ман хеле қобor истифода буд.

   Бо ин роҳ тамоми профor ҷомеа пур карда мешавад:

6. Нишондиҳандаи анбори Шаблон илова кунед .

   Барои ин, ба варианти Танзимот дар анбор гузаред ва қуттиеро, ки дар он гуфта мешавад Анбори Шаблонҳо навишта шудааст, санҷед:

   Ва ин аст, қолаби эҷоди лоиҳаҳои нав омода аст. Ҳамин тариқ, мо дар оянда ҳангоми сохтани лоиҳаҳои нав вақти зиёдро сарфа мекунем. Ин инчунин ба шумо кӯмак мекунад, ки тафсилоти муҳимро аз даст надиҳед, зеро аксар вақт чунин мешавад, ки шумо илова кардани чизеро фаромӯш мекунед, масалан, иҷозатнома ё қолаби равшани масъала.

Чӣ тавр истифода бурдани анбори Шаблон

Ду вариант барои истифода вуҷуд дорад:

1. Вақте ки қолаб бевосита ба шумо тааллуқ дорад: Ҳангоми сохтани анбори нав, ба шумо имкони эҷод кардан аз қолаб аз рӯйхати қолибҳои шумо дода мешавад:

2. Вақте ки қолаб хориҷӣ аст: дар ин ҷо низ мушкилоти махсус вуҷуд надорад. Ба он қолаб равед ва тугмаи Истифодаи ин қолабро пахш кунед . Дар ин ҷо ман аниматсияро аз ҳуҷҷати расмӣ истифода хоҳам кард:

Биёед онро чамъбаст кунем

Дар ин мақола мо дида баромадем:

• анбори GitHub чист;
• анбори Шаблон чист;
• дар анбори Шаблон чӣ бояд бошад;
• Чӣ тавр сохтани анбори Шаблон;
• Чӣ тавр истифода бурдани анбори Шаблон.

Албатта, дар асоси ин қолаб, шумо метавонед аллакай намунаҳои мушаххастарро эҷод кунед. Масалан, ман қолабҳои бештареро бо системаҳои сохтани maven ё gradle сохтам , ки аллакай танзим карда шудаанд. Бештар: шумо метавонед дар асоси дуи охирин Шаблони анбори Spring Boot эҷод кунед. Барои гурӯҳбандӣ кардани ҳамаи қолабҳо, ман дар GitHub як созмони шаблон-анборро бо ҳама қолабҳо сохтам. Ба ҳисоби GitHub- и ман обуна шавед

истинодҳои муфид

• Ташкилот бо ҳама қолабҳои ман офаридаам
• GitHub Blog: Эҷоди анбори нав бо қолибҳои репозиторий чӣ гуна сохтани қолаб барои анборҳо
• Кӯмаки GitHub: Дар бораи анборҳо дар бораи он ки анборҳо чист.
• Кӯмаки GitHub: Эҷоди анбор аз қолаб чӣ гуна сохтани лоиҳаи нав дар асоси қолаб
• Кӯмаки GitHub: Иҷозатномадиҳӣ тавсифи анбори иҷозатномадиҳӣ барои лоиҳаҳо
• Кӯмаки GitHub: Тавсифи репо барои эҷоди анбор эҷод кунед
• Маслиҳатҳои Роҳнамои кушодаасос барои эҷод/тавсиф кардани лоиҳаҳои кушодаасос.
• Кӯмаки GitHub: илова кардани қолаби дархост - эҷод кардани қолаб барои дархостҳои кашидан.

Бештар аз мақолаҳои ман

• Debug дар Intellij IDEA: дастур барои шурӯъкунандагон
• Дастур барои эҷоди муштарӣ барои API Skyscanner ва нашри он дар jCenter ва Maven Central [Қисми 1]
• Дастур оид ба эҷоди муштарӣ барои API Skyscanner ва нашри он дар jCenter ва Maven Central [Қисми 2]
• Таъсиси системаи мониторинги нархи чиптаҳои ҳавопаймо: дастури қадам ба қадам [Қисми 1]
• Эҷоди системаи мониторинги нархи чиптаҳои ҳавопаймо: дастури қадам ба қадам [Қисми 2]
• Таъсиси системаи мониторинги нархи чиптаҳои ҳавопаймо: дастури қадам ба қадам [Қисми 3]
• Сабзӣ: чӣ, чӣ тавр, дар куҷо ва бо чӣ?
• Чӣ тавр санҷиши мусоҳиба ба китобхонаи кушодаасос табдил ёфт
• Таърихи муваффақият. 20 соат барномасозӣ дар як ҳафта, дараҷаи магистрӣ ва ҳаёти шахсӣ
• Чӣ тавр пайдо кардани кор? Маслиҳатҳо барои фиристодани резюме