Standardy komentarzy do rewizji

Updated 1,880 Days AgoPublic

Actions

Jednym z zadań recenzenta jest pomaganie autorowi rewizji utrzymywanie kodu na Sealcode'owych standardach. Dodatkowo, same komentarze umieszczane przez recenzenta same z siebie muszą spełniać określone standardy.

Ten dokument jest we wczesnej fazie rozwoju. Docelowo będzie zawierał możliwie zupełną listę cech skutecznego i uprzejmego komentarza w diffie.

1. Poddawaj krytyce kod, a nie jego autora

Postaraj się zawsze stosunkować do kodu, a nie do jego autora/autorki. Pisz językiem "Tutaj coś nie działa", a nie "Tutaj coś popsułeś".

2. Powołuj się na źródło

Kiedy piszesz, że coś powinno być zrobione inaczej (większy font, inny kolor, inna struktura kodu, itp itd), powołaj się na źródło prawdy/opinii. Napisz, czy Twoja uwaga ma swoje poparcie w:

• Standardach Sealcode'u? Nadmień, do którego standardu się odnosisz (możesz z samej nazwy, lub linkiem do konkretnego nagłówka w dokumencie
• własnej opinii lub doświadczeniu? Zaznacz to w treści komentarza. (Wystarczy dodać "moim zdaniem")
• opinii któregoś z członków grupy #Reviewers? - Nadmień, którego