coding style

Styl kodowania

Zalecenia ogólne

• Wszystkie komunikaty, komentarze, nazwy w kodzie, itp. piszemy zawsze po angielsku.
• Czytelność kodu jest ważniejsza niż łatwość jego pisania. Styl optymalizujemy z myślą o ułatwieniu zrozumienia go i znalezienia w nim potencjalnych błędów.
• Zasady zawsze mogą być złamane jeżeli sztywne ich zastosowanie w oczywisty sposób zmniejszyłoby czytelność kodu.
• Dbamy o spójność. Jeżeli widać, że kod, który modyfikujemy ma spójny styl, przede wszystkim staramy dostosować się do tego stylu.

Listy

• W miarę możliwości staramy się zawijać długie listy tak aby jeden element znajdował się w jednej linijce. Dzięki temu w diffie zobaczymy dokładnie co zostało zmienione, zamiast widzieć całą listę jako zmodyfikowaną.

Zalecenia do konkretnych języków i narzędzi

• Python
• Shell
• Git
• Markdown