Dobre praktyki

Na niniejszej stronie znajduje się zbiór zasad jakich należy trzymać się podczas tworzenia projektu. Zasady podzielone są na działy: nazwy plików i katalogów, nazwy zmiennych i funkcji, formatowanie kodu, branching.

Nazwy plików i katalogów

• Nazwy plików piszemy CamelCase'em
• Nazwy katalogów piszemy małymi literami

Nazwy zmiennych i funkcji

Nazwy zmiennych piszemy camelCasem, zaczynając od małej litery. Nazwy klas oraz funkcji również zapisujemy CamelCasem, zaczynając od wielkiej litery.

Nie używamy notacji węgierskiej!

Formatowanie kodu

• Wcięcia robimy tabulacją; 1 tab == 4 spacje 1 tab == 1 tab
• Jako, że Java to lubi używamy "egipskiego" nawiasowania.

Git

Branching - sensowne zasady rozgałęzień. Pamietajcie o rebase'ach kiedy wciągacie kod z mastera do swojego branchu i merge'ach gdy umieszczacie swój kod w masterze.

W wiadomościach do commitów dobrze jest umieszczać numery zadań na githubie np. #9, albo z pełną nazwą Stworzenie strony 'Dobre Praktyki' #9. W ten sposób github rozpozna commit i wyświetli go w odpowiednim zadaniu.