Dziękujemy za chęci pomocy w rozwoju naszego Koła Naukowego 😊
Jestemśmy wdzięczni za chęć udzielania się w naszym projekcie, miło nam jest wiedzieć, że ktoś wyraża nim zainteresowanie ❤❤❤
Opis krok po kroku:
- Na początku, gdy zostanie zlecone Ci zadanie, utwórz brancha na swoim repozytorium, przez zklonowanie repozytorium ChatKNML.
- Na stworzonym przez Ciebie branchu utwórz program. Musisz pamiętać, żeby odpowiednio komentować co robi zmieniony lub dodany przez Ciebie kod, by ułatwić odczytywanie go Twoim wspólnikom. Nie martw się jeżeli popełnisz jakiś błąd, kod w Twoim branchu nie zostanie włączony do kodu głównego do momentu kiedy nie zostanie zmergowany z Mainem 😁.
- Zrób pull requesta - Wejdź w swoje repozytorium, oraz wybierz opcję "Pull Requests", następnie kliknij w zielony przycisk "New pull request". Wpisz tytuł oraz opis pull requesta i jako Reviewers wybierz osobę, która zleciła Ci wykonanie projektu. Jeżeli Twój kod zostanie uznany za dobry otrzymasz zgodę na jego zmergowanie.
- Mergujesz kod z branchem Main i cieszysz się z dobrze wykonanej pracy 🤩.
Commity oraz branche nazywamy tak, by możliwie jak najkrócej opisywały dokonane zmiany.
Caution
Pamiętaj, że staramy się używać języka angielskiego. Komentarze w kodzie, treść pull requestów i commitów powinny być po angielsku.
Króciutko o Github flow:
Github flow jest modelem pracy, dzięki któremu różni członkowie zespołu są w stanie w schludny i zorganizowany sposób prcować nad program nie wchodząc sobie w drogę. W Github flow mamy dwa rodzaje gałęzi:
-🥇Main - na tej gałęzi znajduje się aktualna wercja projektu. Z tej gałęzi tworzymy swoje branche i do niej mergujemy swoje zmiany. -🥈Branch roboczy - na tych gałęziach tworzymy nowe funkcje i naprawiamy błędy w projekcie.
Jeżeli napotkasz jakiś problem nie masz powodu się wstydzić, zgłoś się najlepiej do Mikołaja (dc: Mikołaj "Jimmy" Data, github: TheJimmyNowak) albo Piotrka (dc: Piotr Krawiec, github: Finloop) z chęcią pomogą Ci go rozwiązać!
Discord: https://discord.com/channels/916272670042099723/916414602303144016 Link do projektu na Githubie: https://github.com/knmlprz/ChatKNML
Jeszcze raz dziękujemy Ci za chęć pomocy w naszym projekcie i życzymy powodzenia nad rozwijaniem naszego chatbota (i przy okazji swoich umiejętności 😃)!