Zawsze jest ciężko, kiedy robisz coś po raz pierwszy. Szczególnie gdy współpracujesz z innymi ludźmi, ponieważ popełnianie błędów nie jest niczym przyjemnym. Jednak właśnie na współpracy opiera się idea otwartego oprogramowania. Chcemy nauczyć w prosty sposób nowych programistów jak wgrać swoją pierwszą zmianę w obcym projekcie.
Czytanie artykułów i oglądanie poradników może pomóc, ale czy jest coś lepszego niż spróbowanie czegoś samemu bez obaw, że się coś zepsuje? Ten projekt ma na celu dostarczyć nowicjuszom wskazówek i uprościć proces wgrania pierwszej zmiany. Pamiętaj: im bardziej jesteś zrelaksowany, tym lepiej się uczysz. Jeśli chcesz wgrać swoją pierwszą kontrybucję wykonaj kilka prostych kroków poniżej. Będzie fajnie, obiecujemy.
Jeśli nie masz Gita na swoim komputerze, zainstaluj go .
Zrób fork tego repozytorium klikając przycisk Fork
na górze tej strony. Stworzysz tym samym kopię tego repozytorium na swoim koncie.
Teraz sklonuj repozytorium na swój komputer. Przejdź do swojego konta GitHub, otwórz skopiowane repozytorium, kliknij przycisk Code
, a później ikonkę skopiuj do schowka.
Otwórz konsolę i uruchom komendę git:
git clone <skopiowany-adres>
Gdzie <skopiowany-adres>
to adres tego repozytorium (twojej kopii tego projektu). Zobacz poprzedni krok aby skopiować adres.
Przykład:
git clone https://github.com/to-ty/first-contributions.git
W miejscu to-ty
to twój login na GitHubie. W tym kroku ściągasz zawartość twojej kopii repozytorium first-contributions
z githuba na swój komputer.
Wejdź do folderu ze swoim repozytorium (jeżeli jeszcze tam nie jesteś):
cd first-contributions
Teraz utwórz nową gałąź wykonując polecenie git switch
:
git switch -c <add-twoje-imie>
Przykład
git switch -c add-adam-kowalski
(Nazwa gałęzi nie musi zawierać słowa add, ale dobrze jest je dodać z racji tego, że celem tej gałęzi jest dodanie twojego imienia do listy.)
Otwórz plik Contributors.md
w edytorze tekstu. Musisz znać Markdown, lekki język znaczników. Tu masz ściągawkę gdzie znajdziesz informację jak go używać.
Dodaj następującą linię w Contributors.md
[Twoje imię](https://github.com/Twoja-nazwa-użytkownika)
Przykład:
[John Doe](https://github.com/johndoe)
Nie dodawaj jej na początku ani na końcu pliku. Umieść ją w dowolnym miejscu pomiędzy.
Upewnij się że nie ma spacji pomiędzy ](
. Zapisz plik i następnie go zamknij.
Jeżeli wejdziesz do folderu ze swoim repozytorium i wykonasz komendę git status
, zobaczysz, że są tam zmiany. Dodaj te zmiany do gałęzi którą właśnie utworzyłeś używając komendy git add
:
git add Contributors.md
Teraz zapisz te zmiany wykonując komendę git commit
:
git commit -m "Add <twoje-imie> to Contributors list"
Zastąp <twoje-imie>
swoim imieniem i nazwiskiem.
Wyślij swoje zmiany komendą git push
:
git push -u origin <add-twoje-imie>
Zastąp <add-twoje-imie>
nazwą gałęzi, którą wcześniej utworzyłeś.
W swoim repozytorium na GitHubie znajdziesz przycisk Compare & pull request
. Kliknij go.
Teraz wyślij prośbę o scalenie.
Niedługo dodam proponowane przez ciebie zmiany do głównej gałęzi projektu. Zostaniesz powiadomiony mailowo kiedy zmiany zostaną scalone.
Brawo! Właśnie ukończyłeś standardowy workflow fork -> clone -> edit -> pull request, który często będziesz napotykać jako współtwórca!
Świętuj swoją pierwszą zmianę i podziel się nią z przyjaciółmi i obserwującymi poprzez aplikację.
Możesz dołączyć do naszego kanału slack w przypadku kiedy będziesz potrzebował pomocy albo miał jakieś pytania. Dołącz do slacka.
Możesz teraz zacząć uczestniczyć w innych projektach. Przygotowaliśmy listę projektów z prostymi zadaniami które będą dobre na początek. Sprawdź listę projektów.
GitHub Desktop | Visual Studio 2017 | GitKraken | Visual Studio Code | Atlassian Sourcetree | IntelliJ IDEA |