Skip to content

Dodanie opisu - komentarze jako najważniejsza część code review #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
msosnowskiwsb wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Dodanie opisu - komentarze jako najważniejsza część code review #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions src/main/java/codereview/comment
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Komentarze

Komentarze są najważniejszą częścią code review.

Tutaj można popełnić wiele błędów ale też sprawić że przegląd będzie bardzo pozytywnie odebrany.


Po pierwsze niech Twoje komentarze będą w formie pytania, sugestii a nie rozkazu.

Dobrym przykładem może być “Co myślisz o zmianie nazwy…”, “Dlaczego użyłeś…”. Ich odbiór w porównaniu do np “Zmień to” jest całkiem inny.

Kolejnym plusem tego podejścia jest, to że otwierają pole do dyskusji a autor może się zastanowić.

Komentarze muszą być jasne, konstruktywne i wnosić jakąś wartość. “Zmień to”, “Każdy zrobiłby to lepiej” to właściwie strata czasu. Lepiej powiedz konkretnie, że np możesz użyć wzorca x lub biblioteka y ma tą metodę.