Ten tutorial na GitHubie jest pięknie oparty na DjangoGirls How To Contribute Tutorial, który jest dostępny na licencji Creative Commons Attribution-ShareAlike 4.0.
W tym poradniku będziemy używać repozytorium Briefcase repozytorium jako podstawy dla linków i odnośników.
Pierwsze kroki i wymagania wstępne
Do rozpoczęcia współpracy z BeeWare potrzebne są następujące elementy:
- konto [GitHub] (https://github.com)
- w przypadku złożonych edycji znajomość podstaw wiersza poleceń Git podstawy lub znajomość z aplikacją (Windows i Mac) do przesyłania zmian dokonanych na komputerze do serwisu GitHub.
rozwidlenie repozytorium
Najpierw rozwidl repozytorium Briefcase na swoje osobiste konto GitHub:
Edycja dokumentacji
Proste zmiany
W przypadku prostych zmian, takich jak poprawki literówek, można użyć edytora online GitHub edytora:
- Otwórz lokalną stronę widelca na GitHub,
- przejść do pliku README.rst w dowolnym rozdziale,
- naciśnij ikonę Edit (pióro)
i możesz edytować rozdział bezpośrednio na github.com.
Składnia RST jest używana do edycji poszczególnych stron dokumentacji.
Uwaga
Powyższy zrzut ekranu może nie odzwierciedlać tego, co znajduje się obecnie w repozytorium GitHub. Repozytorium na żywo będzie się od czasu do czasu zmieniać. Proces przesyłania pull requestów pozostaje jednak taki sam.
Zapisz zmiany i utwórz pull request, jak wyjaśniono poniżej.
Nowy kod i złożone zmiany
Aby dodać nowy kod, rozszerzyć klasy lub wprowadzić złożone zmiany, należy pobrać kopię kodu na komputer lokalny.
Użyj aplikacji GitHub dla swojego systemu operacyjnego (wspomnianej powyżej) lub
git, aby pobrać repozytorium lokalnie. Adres repozytorium można uzyskać
ze strony głównej własnego forka repozytorium GitHub:
git clone git@github.com:yourusername/briefcase.git
Następnie utwórz gałąź, w której znajdą się nowe zmiany. Pomocne jest nazwanie gałęzi czymś związanym ze zmianami, które zamierzasz wprowadzić.
git checkout -b update_documentation
Dokonaj wszelkich zmian w kodzie i upewnij się, że zostały one przetestowane i zapisane lokalnie. lokalnie.
Następnie zatwierdź zmiany za pomocą git i prześlij je do zdalnego repozytorium
repozytorium GitHub.
Przykład:
$ git status
W gałęzi update_documentation
Nieśledzone pliki:
(użyj "git add <file>...", aby dołączyć do tego, co zostanie zatwierdzone)
README.rst
git add README.rst
$ git commit -m "Zaktualizuj dokumentację README.rst dla Briefcase"
[update_documentation fe36152] Dodano zrzut ekranu gitbook
Zmieniono 1 plik, 0 wstawień(+), 0 usunięć(-)
create mode 100644 README.rst
$ git push
Zliczanie obiektów: 11, gotowe.
Kompresja delta przy użyciu do 8 wątków.
Kompresja obiektów: 100% (5/5), wykonano.
Zapisywanie obiektów: 100% (5/5), 266,37 KiB | 0 bajtów/s, wykonane.
Łącznie 5 (delta 1), ponownie użyte 0 (delta 0)
Do git@github.com:yourusername/briefcase.git
b37ca59..fe36152 update_documentation -> update_documentation
Tworzenie żądania ściągnięcia
Po zakończeniu wprowadzania zmian należy utworzyć pull request na GitHub. BeeWare otrzyma powiadomienie o pull request, przejrzy wprowadzone zmiany, zasugeruje ewentualne poprawki, a następnie pull zmiany do wersji głównej.
W swoim własnym repozytorium na GitHub naciśnij Compare & pull request.
Uzupełnij informacje dlaczego wprowadzana jest ta zmiana. Recenzent może zobaczyć szczegóły faktycznej zmiany, więc nie trzeba powtarzać treści zmiany.
Następnie naciśnij przycisk Utwórz żądanie ściągnięcia.
Wiadomości e-mail GitHub powiadomią Cię o dalszych działaniach.