wiki:SvnLogFormat

How to write good SVN logs

Always write log comment during the commit. The change may appear obvious to you now, it won't to someone else in a few years. Always write where you got the new files from (eg. "Pin sent me his new SAPs") and why you are making changes ("Miker said he didn't composed it", "Fixed playback with new ASAP"). It's less important to describe what you actually changed - double-clicking a file in TortoiseSVN Log will show changes to AUTHOR, NAME, DATE, etc.

Old discussion (to be continued and translated)

pfusik: I don't think the following makes much sense compared to the above.

This is a draft description for now so that there is something to discuss. Just loose thoughts - I have not yet tested how it would look in practice.

Operations

The user can add, delete and move SAP files to another location.

The user can Wit can add change and delete fields in SAP files.

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

Trac displays SVN logs using its markup. I suggest not to overdo it with it, but there are useful things:

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

You can alternatively write the short forms [256] and #128.

I also configured TortoiseSVN to recognize markup for tickets (ticket: and #). It turns them into clickable links, displays a column in the show log and a field in the commit box. Changeset: links are also worth using in tickets. Repo links can also be useful in tickets.

Last modified 4 months ago Last modified on Oct 14, 2022, 9:05:48 PM