git style

Zasady dotyczące commitowania kodu za pomocą Gita

Ogólne

• Pierwsza linijka opisu commitu jest jego krótkim podsumowaniem. Druga powinna być pusta. Kolejne zawierają dokładniejsze wyjaśnienia, wymieniane od myślników.
• Posumowanie commitu powinno być w trybie rozkazującym.
• W nazwach gałęzi używamy myślników (-), a nie podkreśleń (_).
• Każdy commit powinien być zamkniętą całością. Kod powinien być składniowo poprawny, przechodzić testy, nie powodować nowych warningów, zawierać niezbędne migracje, itp.
• Nigdy nie commitujemy do repozytorium:
  • Plików zawierających hasła lub haseł osadzonych w kodzie.
  • Konfiguracji własnego środowiska.
  • Plików binarnych (skompilowanych plików wykonywalnych, archiwów, itp.).
  • Danych produkcyjnych lub dużych zestawów danych testowych.
  • Backupów.
  • Cache'u systemu operacyjnego lub edytora (pliki typu .swp, Thumbs.db, .DS_Store)

Django

• Jeżeli commit zawiera migrację, jego opis powinien zaczynać się od [M] .