Przejdź do głównej zawartości

Komentuj i sugeruj poprawki

Opracowanie: Stefan Wajda
Data zgłoszenia: 18 października 2025 r., ostatnia aktualizacja: 3 maja 2026 r.

Cel​

Nauczysz się:

  • dodawać komentarze do dokumentów,
  • proponować konkretne poprawki.

Kiedy używać​

Gdy:

  • chcesz zgłosić uwagę do dokumentu,
  • chcesz zaproponować zmianę w tekście,
  • bierzesz udział w ocenie projektu.

Dwa sposoby pracy​

Możesz komentować na dwa sposoby:

  1. przez Issues – prosto, ale mniej precyzyjnie
  2. bezpośrednio w dokumencie (pull request) – dokładnie i zalecane

👉 Zalecamy sposób drugi.

Sposób 1. Dodaj komentarz (Issues)​

Dodanie nowego komentarza​

  1. Otwórz repozytorium.
  2. Wybierz zakładkę „Issues”.
  3. Wybierz „New Issue”.
  4. Wpisz:
    • tytuł,
    • treść komentarza.
  5. Wybierz „Create”.

Komentarz do istniejącego zgłoszenia​

  1. Otwórz „Issues”.
  2. Wybierz zgłoszenie.
  3. Przejdź do pola „Add a comment”.
  4. Wpisz komentarz i wyślij.

👉 Ten sposób jest prosty, ale nie pozwala wskazać dokładnego miejsca w tekście.

Sposób 2. Komentuj w dokumencie (zalecane)​

1. Otwórz projekt​

  1. Przejdź do zakładki „Pull requests”.
  2. Wybierz projekt, który chcesz skomentować.

2. Przejdź do plików​

Wybierz zakładkę „Files changed”.

Zobaczysz dokument z zaznaczonymi zmianami.

3. Wybierz fragment​

Znajdź fragment tekstu, do którego chcesz się odnieść.

Aby dodać komentarz:

  • przejdź do wybranego wiersza,
  • uruchom opcję dodania komentarza (przycisk „+” lub odpowiednie pole).

👉 W czytniku ekranu:

  • przechodź między wierszami klawiszem Tab,
  • szukaj przycisku „Add comment” lub podobnego.

4. Dodaj komentarz​

W polu edycji wpisz swoją uwagę.

Możesz:

  • wskazać problem,
  • zaproponować zmianę,
  • zadać pytanie.

5. Dodaj sugestię poprawki (opcjonalnie)​

Jeśli chcesz zaproponować konkretną zmianę:

  1. wybierz opcję „Add suggestion”,
  2. zmień tekst w edytorze,
  3. zapisz sugestię.

6. Wyślij recenzję​

  1. Wybierz „Start review” (jeśli dodajesz kilka uwag),
  2. po zakończeniu wybierz „Submit review”.

Twoje komentarze zostaną zapisane przy dokumencie.

Jak pisać dobre komentarze​

  • pisz konkretnie („ten fragment jest niejasny” zamiast „źle napisane”),
  • jeśli możesz – zaproponuj poprawkę,
  • odnoś się do fragmentu tekstu,
  • unikaj ogólnych ocen bez uzasadnienia.

Co może pójść nie tak​

Nie widzę miejsca do komentarza

Upewnij się, że jesteś w zakładce „Files changed”.

Nie mogę dodać komentarza do fragmentu

Możesz:

  • dodać komentarz ogólny,
  • albo użyć Issues.

Nie wiem, co poprawić

To normalne.
Zadaj pytanie zamiast proponować zmianę.

Wskazówki dla osób korzystających z czytnika ekranu​

  • Pracuj w zakładce „Files changed”.
  • Szukaj przycisków:
    • „Add comment”
    • „Add suggestion”
    • „Start review”
    • „Submit review”
  • Przemieszczaj się między elementami klawiszem Tab.
  • Jeśli trudno znaleźć konkretny fragment:
    • użyj wyszukiwania w tekście,
    • albo dodaj komentarz ogólny.

Co dalej​

Po dodaniu komentarzy:

  • autor może wprowadzić zmiany,
  • możesz wrócić i sprawdzić poprawki,
  • dyskusja jest zapisywana przy projekcie.