How to write good SVN logs

Always write log during the commit. Always write where you got the new files from ("

Old discussion (to be translated)

Jest to na razie draft opisu, aby było nad czym dyskutować. Tylko luźne myśli - nie testowałem jeszcze, jak by to wyglądało w praktyce.

Operacje

Użytkownik może sapy dodawać, usuwać i przemieszczać w inne miejsce.

W ramach sapów może dodawać zmieniać i usuwać pola

Oznaczenia działań na plikach

Są 3 statusy zmian w hierarchii katalogów:

• NEW oznacza dodane pliki w ramach commita.
• DELETED oznacza usunięte pliki w ramach commita (raczej rzadko :)
• MOVED oznacza przeniesione w inne miejsce w hierarchii katalogów pliki w ramach commita.

Czyli zamiast "dodano nowe sapy" piszemy "NEW". Jeśli coś dodatkowego trzeba dodać to piszemy POD new.

pfusik: Popieram. Dodatkowo MOVED zwykle wiąże się z dopisaniem lub zmianą AUTHOR (i ew. innych tagów), więc przydałby się jakiś skrót.

Oznaczenia działań na atrybutach plików

• ADDED <field> [field] ...
• MODIFIED <field> [field] ...
• DELETED <field> [field] ...

Wartość zaznaczyłem jako opcję, bo jest ona do wyciągnięcia przez diff, a nie chcemy się duplikować. Czyli trzeba napisać narządko, które dla wersji od x do y zrobi ładny changelog.

pfusik: Ok. Dla MODIFIED i DELETED przydałoby się uzasadnienie, w tym pierwszym "literówka" / "było źle" / ...

Oznaczenia zmian w binariach

To jest IMHO najważniejsze, bo najtrudniej to wyciągnąć z innych pól SVNa. Kojarzę takie przypadki:

• poprawione nieprawidłowe dźwięki
• dodane subsongi (w sumie to widać w tagu SONGS)
• wyrzucone śmieci (krótszy plik)
• nie grało na Atari
• nie grało na ASAP / SAP Player / ...
• nowsza wersja muzyki

Linki Trac

Trac wyświetla logi SVN używając swojego markupu. Proponuję z nim nie przesadzać, ale są rzeczy pożyteczne, np.

"Fixed file broken in changeset:256". "Fixed ticket:128".

Można alternatywnie pisać [256] i #128, ale to mniej rzuca się jako markup.

Skonfigurowałem też TortoiseSVN, aby rozpoznawał markup dla ticketów (ticket: i #) - zamienia go na klikalne linki, wyświetla kolumnę w show log i pole w okienku commit. Linków changeset: warto też używać w ticketach. W ticketach mogą się też przydać linki do repo.