Dodaj dokument z Github Destkop

Opracowanie: Stefan Wajda

Data zgłoszenia: 18 października 2025 r., ostatnia aktualizacja: 18 października 2025 r.

Wskazówka

Ten poradnik objaśnia, jak dodać swój projekt zalecenia, rozwiązania lub opis praktyki w środowisku Github Destkop.

Aby dodać swój projekt bezpośrednio w repozytorium Sieci, zobacz Dodaj dokument na Github.

Aby dodawać do repozytorium Sieci dokumenty i zgłaszać poprawki do dokumentów, korzystamy z funkcji pull requesty.

Funkcja Pull requesty jest stworzona do tego, aby proponować, a następnie analizować, testować, rozwijać, korygować, przeglądać, komentować i zatwierdzać zmiany w kodzie. Doskonale sprawdzi się także w przypadku dokumentów z projektami zaleceń, rozwiązań i opisami praktyk.

Proces dodawania do repozytorium nowego dokumentu składa się z kilku etapów:

• utworzenie w repozytorium nowej gałęzi
• utworzenie w tej gałęzi nowego dokumentu lub poprawki w istniejącym dokumencie
• skomitowanie do repozytorium wprowadzonej zmiany (nowego lub poprawionego dokumentu lub zestawu dokumentów)
• wysłanie gałęzi ze zmianami na Github
• utworzenie i otwarcie pull requesta.

Utwórz gałąź

Gałąź (ang. branch to kopia głównej wersji plików składających się na cały projekt. Dzięki gałęziom wiele osób może równolegle rozwijać projekt - w przypadku oprogramowania dodawać i testować nowe funkcje, a w naszym przypadku dodawać i rozpatrywać dokumenty projektowe, dyskutować nad nimi i korygować je bez wpływu na główne zaakceptowane lub robocze wersje dokumentów projektu.

Gdy kształt nowych projektów dokumentów albo poprawek do istniejących dokumentów zostanie uzgodniony, zostają one scalone z główną wersją projektu, a gałąź jest usuwana. W przypadku, gdy ktoś uzna za potrzebne wprowadzenie do dokumentu scalonego z główną wersją projektu jakiejkolwiek poprawki, tworzy się nową gałąź.

Github przechowuje wszystkie uzgodnione i poprawione wersje dokuemntów, a także historię dyskusji nad nimi. Dzięki temu można w razie potrzeby przywrócić każdą z wcześiejszych wersji.

Gałąź może być utworzona w kopii repozytorium na koncie użytkownika Github albo bezpośrednio w głównym repozytorium. Zasady pracy Sieci skonfigurowaliśmy tak, że gałęzie tworzone są z zasady w repozytoriach na kontach uczestników Sieci.

Gdy w Github Destkop utworzysz pierwszą gałąź dla swojego pierwszego projektu, na Twoim koncie GitHub zostanie utworzony tzw. fork, czyli Twoje rozgałęzienie repozytorium, które będzie pośredniczyć w zgłaszaniu Twoich projektów oraz propozycji poprawek do dokumentów scalonych z głównym repozytorium projektu.

Ten poradnik omawia procedurę dodawania nowych dokumentów i propozycji poprawek do scalonych dokumentów za pomocą aplikacji Github Destkop działającej na komputerze lokalnym.

Domyślnie GitHub Destkop otwiera kopię głównej gałęzi projektu.

Aby w Github Destkop utworzyć gałąź repozytorium Sieci dla swoich propozycji:

1. Rozwiń listę Current branch (bieżąca gałąź):
   
   
   
   
2. Wybierz przycisk New branch (Nowa gałąź):
   
   
3. Pojawi się formularz Create branch (Utwórz gałąź). Wpisz w polu Name nazwę nowej gałęzi – używaj tylko liter łacińskich i cyfr, nie zostawiaj spacji, wyrazy oddzielaj znakami łącznika, np. moj-projekt
   
   
   
   
4. Wybierz przycisk Create branch
   
   
5. Forkuj repozytorium. Gdy po raz pierwszy tworzysz gałąź, pojawi się na kolejnym ekranie pytanie, Do you want to fork this repository? (Czy chcesz utworzyć fork tego repozytorium?). Wybierz przycisk Fork this repository.
   
   
   
   Na Twoim koncie Github zostanie utworzony fork, czyli rozwidlenie repozytorium Sieci.
   
   
6. Na ekranie How are you planning to use this fork (Jak planujesz korzystać z rozgałęzienia) pozostaw zaznaczoną opcję To contribute to the parent project (Do współpracy nad macierzystym projektem) i wybierz przycisk Continue (Kontynuuj)
   
   
   
   
7. Opublikuj rozwidlenie. Na kolejnym ekranie Publish your branch wybierz opcję Publish branch (Opublikuij gałąź):
   
   
   
   

Zauważ, że po opublikowaniu utworzonej gałęzi zostanie ona automatycznie wybrana jako domyślna. Zauważ też, że w bocznym pasku pojawiła się sekcja umożliwiająca przesłanie propozycji zmiany.

Dodaj nowy projekt

Aby dodać nowy projekt:

1. Wybierz w oknie GitHub Destkop polecenie Open in external editor (Otwórz w zewnętrznym edytorze)
   
   
   
   

2. W drzewie katalogów rozwiń kolejno foldery documentation i docs, następnie folder wymiaru, w którym chcesz dodać projekt, a w nim folder nowe-projekty
   
   
   
   

3. Utwórz nowy plik i nadaj mu nazwę, np. moj-piekny-projekt.md.
   Nazwa nie może zawierać spacji, wyrazy oddzielaj łącznikami. Używaj w nazwach tylko małych liter z zestawu alfabetu łacińskiego (polskie znaki zastąp odpowiednikami np. wpisuj a zamiast ą. Do nazwy pliku dodaj po kropce rozszerzenie .md wskazujące na format Makdown:
   
   

4. Dodaj treść dokumentu.
   Treść zapisujemy za pomocą bardzo prostego formatu Markdown. Na ilustracji widać kilka typowych elementów:
   Pierwsza sekcja dokumentu to metadane, tzw. FrontMater. Rozpoczyna ją i kończy wiersz z trzema myślnikami. Między myślnikami umieszczamy wiersze z danymi o dokumencie:
   

   ---
   id: moj-piekny-projekt
   description: "Rozwiązuje \"wszystkie problemy\" dostępności cyfrowej w organizacji"
   ---  

   Obowiązuje tu składnia: nazwa_danej: treść danej. Najpierw wpisujemy nazwę danej, po nazwie stawiamy dwukropek i robimy jedną spację, a następnie zapisujemy treść danej. Jeśli chcemy użyć w treści dwukropka albo znaków cala, to całą treść musimy objąć znakami cala, a znaki cala wewnątrz poprzedzamy znakiem ucieczki (lewym ukośnikiem).
   

   
   
   Aby utworzyć nagłówek 1 stopnia, zaczynamy wiersz od znaku #, nagłówek drugiego stopnia - od dwóch znaków ##, itd.
   Aby utworzyć nowy akapit, rozpoczynamy tekst od nowej linii poprzedzonej pustym wierszem.
   Aby utworzyć punkt listy z punktorem rozpoczynamy wiersz od myślnika albo gwiazdki.
   Aby rozpocząć punkt listy numerowanej, rozpoczynamy wiersz od cyfry 1.

Wykonaj commit

Gotowy dokument musimy wysłać do repozytorium. Informatycy mówią: skomitować, bo służy do tego funkcja commit.

1. Wróć z edytora do okna Github Destkop. W głównym obszarze znajduje się zmieniona treść, a w bocznym panelu okno z formularzem do opisu commitu.
2. Wpisz tytuł projektu w nagłówku formularza
3. Wprowadź krótki opis projektu w polu tekstowym.
4. Wybierz przycisk wysyłania Commit 1 file to… Wyślij 1 plik do…. Dokument zostanie przesłany do Twojej kopii repozytorium.
   
   

Przygotuj pull request

1. Wybierz w oknie głównym Github Destkop polecenie Preview the Pull Request from your current branch (Wyświetl podgląd żądania scalenia z bieżącej gałęzi)
   
   
   
   
2. W oknie głównym Github Destkop pojawi się podgląd dokumentu gotowego do scalenia (Able to merge). Wybierz przycisk Create pull request (Utwórz żądanie scalenia)
   
   
   
   
3. Program przeniesie Cię na stronę Open a pull request w repozytorium Sieci. Możesz tu jeszcze poprawić tytuł i opis. Zwykle wystarczy po prostu wybrać przycisk Create pull request (Utwórz żądanie scalenia)
   
   

Sprawdź poprawność

Po otwarciu żądania scalenia (pull requesta) Github uruchomi automatyczne testy poprawności.

1. Zobacz przebieg testów automatycznych. Przebieg testów jest widoczny na stronie z pull requestem, poniżej opisu:
   
   
2. Zobacz wynik. O poprawnym wyniku testów informują dwa komunikaty: All checks have passed (Wszystkie testy zakończyły się pomyślnie) oraz No conflicts with the base branch (Brak konfliktów z gałęzią bazową). Dodatkowo poprawny wynik sygnalizują ikony z białą fiszką na zielonym tle.
   
   
3. Popraw błędy. Jeśli wynik testów nie będzie poprawny, spróbuj znaleźć błędy w dokumencie, np. czy linki są poprawne. Jeśli nie wiesz, co sprawdzać, nie przejmuj się! Przejrzymy Twój dokument i poprawimy ewentualne błędy.

Gotowe!

Możesz sprawdzić na karcie Pull request, że Twoja propozycja została dodana. Administrator przejrzy Twój dokument, poprawi go w razie potrzeby lub zamieści komentarz z informacją, co należy poprawić. Jeśli dokument będzie poprawny, opatrzy go etykietami oraz przypisze Ci odpowiedzialnosć za dokument. Może także zlecić konkretnym współpracownikom dokonanie przeglądu.