29 KiB

Raw Blame History Unescape Escape

Въведение в GitHub

Този урок обхваща основите на GitHub, платформа за хостване и управление на промените във вашия код.

Скица от Tomomi Imura

Предварителен тест

Въведение

В този урок ще разгледаме:

проследяване на работата, която вършите на вашата машина
работа по проекти с други хора
как да допринасяте за софтуер с отворен код

Предварителни изисквания

Преди да започнете, трябва да проверите дали Git е инсталиран. В терминала въведете:
git --version

Ако Git не е инсталиран, изтеглете Git. След това настройте вашия локален Git профил в терминала:

git config --global user.name "вашето-име"
git config --global user.email "вашият-имейл"

За да проверите дали Git вече е конфигуриран, можете да въведете: git config --list

Ще ви е необходим и акаунт в GitHub, текстов редактор за код (като Visual Studio Code) и ще трябва да отворите вашия терминал (или команден прозорец).

Посетете github.com и създайте акаунт, ако все още нямате такъв, или влезте и попълнете вашия профил.

✅ GitHub не е единственото хранилище за код в света; има и други, но GitHub е най-известното.

Подготовка

Ще ви е необходима папка с проект на код на вашата локална машина (лаптоп или компютър) и публично хранилище в GitHub, което ще служи като пример за това как да допринасяте за проекти на други хора.

Управление на кода

Да кажем, че имате папка локално с някакъв проект на код и искате да започнете да проследявате вашия напредък, използвайки git - системата за контрол на версиите. Някои хора сравняват използването на git с писане на любовно писмо до бъдещото ви аз. Четейки вашите съобщения за комити дни, седмици или месеци по-късно, ще можете да си припомните защо сте взели дадено решение или да "върнете" промяна - стига да пишете добри "съобщения за комити".

Задача: Създайте хранилище и комитнете код

Вижте видеото

Създайте хранилище в GitHub. В GitHub.com, в раздела с хранилища или от навигационната лента горе вдясно, намерете бутона new repo.
1. Дайте име на вашето хранилище (папка).
2. Изберете create repository.
Навигирайте до вашата работна папка. В терминала преминете към папката (известна също като директория), която искате да започнете да проследявате. Въведете:
```
cd [name of your folder]
```
Инициализирайте git хранилище. Във вашия проект въведете:
```
git init
```
Проверете статуса. За да проверите статуса на вашето хранилище, въведете:
```
git status
```
Резултатът може да изглежда така:
```
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git checkout -- <file>..." to discard changes in working directory)

     modified:   file.txt
     modified:   file2.txt
```
Обикновено командата git status ви казва неща като кои файлове са готови за записване в хранилището или имат промени, които може да искате да запазите.
Добавете всички файлове за проследяване
Това също се нарича поставяне на файлове в зоната за подготовка.
```
git add .
```
Аргументът git add плюс . означава, че всички ваши файлове и промени ще бъдат проследявани.
Добавете избрани файлове за проследяване
```
git add [file or folder name]
```
Това ни помага да добавим само избрани файлове в зоната за подготовка, когато не искаме да комитнем всички файлове наведнъж.
Премахнете всички файлове от зоната за подготовка
```
git reset
```
Тази команда ни помага да премахнем всички файлове от зоната за подготовка наведнъж.
Премахнете конкретен файл от зоната за подготовка
```
git reset [file or folder name]
```
Тази команда ни помага да премахнем само конкретен файл от зоната за подготовка, който не искаме да включим в следващия комит.
Запазване на вашата работа. На този етап сте добавили файловете в така наречената зона за подготовка. Това е място, където Git проследява вашите файлове. За да направите промяната постоянна, трябва да комитнете файловете. За да създадете комит, въведете следното:
```
git commit -m "first commit"
```
Това комитва всички ваши файлове, добавяйки съобщението "first commit". За бъдещи съобщения за комити ще искате да бъдете по-описателни, за да предадете какъв тип промяна сте направили.
Свържете вашето локално Git хранилище с GitHub. Git хранилище е полезно на вашата машина, но в даден момент ще искате да имате резервно копие на вашите файлове някъде и също така да поканите други хора да работят с вас върху вашето хранилище. Едно такова чудесно място е GitHub. Помните, че вече създадохме хранилище в GitHub, така че единственото, което трябва да направим, е да свържем нашето локално Git хранилище с GitHub. Командата git remote add ще направи точно това. Въведете следната команда:

Забележка: преди да въведете командата, отидете на страницата на вашето GitHub хранилище, за да намерите URL адреса на хранилището. Ще го използвате в командата по-долу. Заменете https://github.com/username/repository_name.git с вашия GitHub URL.
```
git remote add origin https://github.com/username/repository_name.git
```
Това създава remote или връзка, наречена "origin", сочеща към GitHub хранилището, което създадохте по-рано.
Изпратете локалните файлове в GitHub. Досега сте създали връзка между локалното хранилище и GitHub хранилището. Нека изпратим тези файлове в GitHub със следната команда git push, както следва:

Забележка: името на вашия клон може да е различно по подразбиране от main.
```
git push -u origin main
```
Това изпраща вашите комити в клона "main" в GitHub.
Добавяне на още промени. Ако искате да продължите да правите промени и да ги изпращате в GitHub, ще трябва да използвате следните три команди:
```
git add .
git commit -m "type your commit message here"
git push
```
Съвет: Може също да искате да използвате файл .gitignore, за да предотвратите появата на файлове, които не искате да проследявате, в GitHub - например файл с бележки, който съхранявате в същата папка, но няма място в публично хранилище. Можете да намерите шаблони за файлове .gitignore на .gitignore templates.

Съобщения за комити

Чудесно заглавие на съобщение за Git комит завършва следното изречение:
Ако бъде приложено, този комит ще <вашето заглавие тук>.

За заглавието използвайте повелително наклонение в сегашно време: "променя" вместо "променено" или "променя се".
Както в заглавието, така и в тялото (по избор) използвайте повелително наклонение в сегашно време. Тялото трябва да включва мотивацията за промяната и да я сравнява с предишното поведение. Обяснявате защо, а не как.

✅ Отделете няколко минути, за да разгледате GitHub. Можете ли да намерите наистина страхотно съобщение за комит? А минимално такова? Каква информация според вас е най-важна и полезна за предаване в съобщение за комит?

Задача: Сътрудничество

Основната причина за качването на неща в GitHub е да се направи възможно сътрудничеството с други разработчици.

Работа по проекти с други хора

Вижте видеото

Във вашето хранилище навигирайте до Insights > Community, за да видите как вашият проект се сравнява с препоръчаните стандарти на общността.

Ето някои неща, които могат да подобрят вашето GitHub хранилище:

Описание. Добавихте ли описание на вашия проект?
README. Добавихте ли README? GitHub предоставя насоки за писане на README.
Насоки за принос. Има ли вашият проект насоки за принос?
Кодекс на поведение. Има ли Кодекс на поведение?
Лиценз. Може би най-важното, има ли лиценз?

Всички тези ресурси ще бъдат от полза за въвеждането на нови членове на екипа. Това са обикновено нещата, които новите сътрудници разглеждат, преди дори да погледнат вашия код, за да разберат дали вашият проект е подходящото място за тях да инвестират времето си.

✅ README файловете, въпреки че отнемат време за подготовка, често се пренебрегват от заети поддържащи. Можете ли да намерите пример за особено описателен README? Забележка: има някои инструменти за създаване на добри README файлове, които може да искате да опитате.

Задача: Сливане на код

Документите за принос помагат на хората да допринасят за проекта. Те обясняват какви видове приноси търсите и как работи процесът. Сътрудниците ще трябва да преминат през серия от стъпки, за да могат да допринесат за вашето хранилище в GitHub:

Форкване на вашето хранилище. Вероятно ще искате хората да форкнат вашия проект. Форкването означава създаване на копие на вашето хранилище в техния GitHub профил.
Клониране. Оттам те ще клонират проекта на своята локална машина.
Създаване на клон. Ще искате да ги помолите да създадат клон за своята работа.
Фокусиране върху една област. Помолете сътрудниците да концентрират своите приноси върху едно нещо наведнъж - така шансовете да можете да слеете тяхната работа са по-големи. Представете си, че те пишат поправка на грешка, добавят нова функция и актуализират няколко теста - какво ако искате или можете да приложите само 2 от 3, или 1 от 3 промени?

✅ Представете си ситуация, в която клоновете са особено критични за писането и доставянето на добър код. Какви случаи на употреба можете да си представите?

Забележка: бъдете промяната, която искате да видите в света, и създавайте клонове и за вашата собствена работа. Всички комити, които правите, ще бъдат направени в клона, в който в момента сте "чекнати". Използвайте git status, за да видите в кой клон се намирате.

Нека преминем през работния процес на сътрудник. Да предположим, че сътрудникът вече е форкнал и клонирал хранилището, така че има готово Git хранилище на своята локална машина:

Създаване на клон. Използвайте командата git branch, за да създадете клон, който ще съдържа промените, които възнамеряват да допринесат:
```
git branch [branch-name]
```
Превключване към работния клон. Превключете към посочения клон и актуализирайте работната директория с git switch:
```
git switch [branch-name]
```
Работа. На този етап искате да добавите вашите промени. Не забравяйте да уведомите Git за това със следните команди:
```
git add .
git commit -m "my changes"
```
Уверете се, че давате добро име на вашия комит, както за вас, така и за поддържащия на хранилището, на което помагате.
Комбиниране на вашата работа с клона main. В даден момент сте готови с работата си и искате да я комбинирате с тази на клона main. Клонът main може да се е променил междувременно, така че се уверете, че първо го актуализирате до последната версия със следните команди:
```
git switch main
git pull
```
На този етап искате да се уверите, че всички конфликти, ситуации, в които Git не може лесно да комбинира промените, се случват във вашия работен клон. Затова изпълнете следните команди:
```
git switch [branch_name]
git merge main
```
Това ще внесе всички промени от main във вашия клон и, надяваме се, ще можете просто да продължите. Ако не, VS Code ще ви покаже къде Git е объркан и просто ще промените засегнатите файлове, за да посочите кое съдържание е най-точно.
Изпращане на вашата работа в GitHub. Изпращането на вашата работа в GitHub означава две неща. Пушване на вашия клон във вашето хранилище и след това отваряне на PR (Pull Request).
```
git push --set-upstream origin [branch-name]
```
Горната команда създава клона във вашето форкнато хранилище.
Отваряне на PR. След това искате да отворите PR. Това става, като навигирате до форкнатото хранилище в GitHub. Ще видите индикация в GitHub, където се пита дали искате да създадете нов PR, кликнете върху това и ще бъдете отведени до интерфейс, където можете да промените заглавието на съобщението за комит, да му дадете по-подходящо описание. Сега поддържащият на хранилището, което сте форкнали, ще види този PR и с кръстени пръсти ще оцени и слее вашия PR. Вече сте сътрудник, ура :)
Почистване. Счита се за добра практика да почистите след успешно сливане на PR. Искате да изчистите както вашия локален клон, така и клона, който сте пушнали в GitHub. Първо, нека го изтрием локално със следната команда:
```
git branch -d [branch-name]
```
Уверете се, че отивате на страницата на GitHub за форкнатото хранилище и премахнете отдалечения клон, който току- Pull request изглежда като странен термин, защото всъщност искате да "пушнете" вашите промени към проекта. Но поддръжникът (собственикът на проекта) или основният екип трябва да разгледат вашите промени, преди да ги обединят с "главния" клон на проекта, така че всъщност искате решение за промяна от поддръжника.

Pull request е мястото, където се сравняват и обсъждат разликите, въведени в даден клон, с ревюта, коментари, интегрирани тестове и други. Един добър pull request следва приблизително същите правила като съобщение за commit. Можете да добавите препратка към проблем в тракера за проблеми, например когато вашата работа решава даден проблем. Това се прави с помощта на #, последвано от номера на проблема. Например #97.

🤞Стискайте палци всички проверки да преминат успешно и собствениците на проекта да обединят вашите промени в проекта🤞

Актуализирайте текущия локален работен клон с всички нови commit-и от съответния отдалечен клон в GitHub:

git pull

Как да допринесете за отворен код

Първо, намерете хранилище (или repo) в GitHub, което ви интересува и към което искате да допринесете с промяна. Ще искате да копирате съдържанието му на вашата машина.

✅ Добър начин да намерите хранилища, подходящи за начинаещи, е като търсите по етикета 'good-first-issue'.

Има няколко начина за копиране на код. Един от тях е да "клонирате" съдържанието на хранилището, използвайки HTTPS, SSH или GitHub CLI (Command Line Interface).

Отворете вашия терминал и клонирайте хранилището по следния начин: git clone https://github.com/ProjectURL

За да работите по проекта, преминете към правилната папка: cd ProjectURL

Можете също така да отворите целия проект, използвайки Codespaces, вградения редактор на код / облачна среда за разработка на GitHub, или GitHub Desktop.

Накрая, можете да изтеглите кода в компресиран файл.

Още няколко интересни неща за GitHub

Можете да добавите звезда, да следите или да "форкнете" всяко публично хранилище в GitHub. Можете да намерите вашите хранилища със звезди в падащото меню горе вдясно. Това е като да запазите отметка, но за код.

Проектите имат тракер за проблеми, обикновено в раздела "Issues" в GitHub, освен ако не е посочено друго, където хората обсъждат проблеми, свързани с проекта. А разделът "Pull Requests" е мястото, където хората обсъждат и преглеждат промени, които са в процес на работа.

Проектите може също да имат дискусии във форуми, пощенски списъци или чат канали като Slack, Discord или IRC.

✅ Разгледайте вашето ново хранилище в GitHub и опитайте няколко неща, като редактиране на настройки, добавяне на информация към вашето хранилище и създаване на проект (като Канбан дъска). Има много неща, които можете да направите!

🚀 Предизвикателство

Работете в екип с приятел върху кода на другия. Създайте проект съвместно, форкнете код, създайте клонове и обединете промените.

Тест след лекцията

Преглед и самостоятелно обучение

Прочетете повече за допринасянето към софтуер с отворен код.

Git cheatsheet.

Практика, практика, практика. GitHub предлага страхотни учебни пътеки чрез skills.github.com:

Първата седмица в GitHub

Ще намерите и по-напреднали курсове.

Задание

Завършете курса "Първата седмица в GitHub"

Отказ от отговорност:
Този документ е преведен с помощта на AI услуга за превод Co-op Translator. Въпреки че се стремим към точност, моля, имайте предвид, че автоматизираните преводи може да съдържат грешки или неточности. Оригиналният документ на неговия изходен език трябва да се счита за авторитетен източник. За критична информация се препоръчва професионален превод от човек. Ние не носим отговорност за каквито и да е недоразумения или погрешни интерпретации, произтичащи от използването на този превод.

29 KiB Raw Blame History Unescape Escape