DobrePraktyki - Gonz8/RSO-16L GitHub Wiki

Dobre praktyki

1. Nazwy zmiennych, procedur klas zapisujemy przy użyciu notacji camelCase ( np. mojaFunkcja() )
2. Przed definicją funkcji umieść w komentarzu krótki opis parametrów funkcji i jej zachowanie
3. Ustalono, że zmienne, funkcje, klasy itp. nazywać będziemy w języku angielskim.
4. Staramy się nie kopiować kodu i uwspólniać kod jeśli się da, aby zmniejszyć ryzyko błędów
5. Formatujemy kod w celu zwiększenia jego czytelności
6. Nie piszemy za dużo kodu w jednej linii, przyjęty limit to 150 znaków
7. Nie należy zostawiać kodu służącego wyłącznie do debugowania
8. W przypadku dosyć niezrozumiałego (skomplikowanego) fragmentu kodu warto napisać kilka linijek komentarza z opisem działania i możliwymi, niepożądanymi zachowaniami
9. Nie tworzymy funkcji, metod, które mają 500 linijek kodu i wiele parametrów. Rozsądniej jest podzielić ten kod na kilka funkcji.
10. Upewnij się, że pracujesz na aktualnej wersji źródeł.
11. Zawsze (w miarę dokładnie) opisujemy commit'y
12. Swoje zmiany zawsze przetestuj praktycznie, a nie tylko teoretycznie (testy jednostkowe)

Pamiętaj ! Należy modyfikować kod małymi, ale kompletnymi partiami, tak by wszyscy programiści pracowali niezależnie, a ich praca nie nakładała się.