Współpraca

Jeśli jesteś zainteresowany współtworzeniem Subsurface, dobrym pomysłem jest dołączenie do naszej listy mailingowej. Lista ta jest anglojęzyczna. Pomimo, że ta strona, oraz sam program Subsurface, są dostępne w wielu językach, wspólnym mianownikiem używanym przez nas do komunikacji jest język angielski. Niekoniecznie musi być bardzo poprawny ;)

Często też można spotkać niektórych naszych programistów na kanale #subsurface na Freenode.

Jest wiele sposobów, na które możesz pomóc. Stale szukamy testerów, którzy chcieliby testować najnowszą, rozwojową wersję Subsurface. W szczególności zależy nam na osobach używających systemów Windows i Mac (większość naszych programistów używa Linuksów). Szukamy też ochotników, którzy mogliby pomóc w ulepszaniu dokumentacji. Potrzebujemy także tłumaczy. Do tłumaczenia używamy Transifex -- jeśli chcesz pomóc, załóż tam konto i wyślij wniosek o dołączenie do ekipy Subsurface Team.

Jeśli chcesz podzieli się z nami kodem (patch) naprawiającym jakiś błąd lub dodającym nowa funkcjonalność, jest to szczególnie mile widziane. Poniżej znajdziesz krótką instrukcję jak poprawnie przygotować dla nas kod. Więcej szczegółów dotyczących posługiwania się gitem znajdziesz w instrukcji obsługi gita.

Zacznij od pobrania najnowszej wersji kodu źródłowego (dokładniejszy opis znajdziesz na stronie Kod Źródłowy).
cd subsurface
git checkout master
git pull

Utwórz swoją gałąź roboczą:
git checkout -b devel
Teraz możesz edytować kod (lub dokumentację), kompilować, testować…… a na koniec zatwierdzić swoje zmiany:
git commit -s -a
Powinno to otworzyć domyślny edytor tekstu (zależny od Twojego systemu operacyjnego -- wyboru dokonuje się poprzez zmienną środowiskową GIT_EDITOR). Tu wprowadzasz opis swoich zmian. Pierwsza linijka to tytuł -- powinna być krótka i konkretna. Po niej następuje opis ( więcej na ten temat oraz o podpisywaniu zmian przeczytasz poniżej)
Jeśli chcesz zmienić opis, użyj „git commit --amend”. Możesz podzielić swoje zmiany na kilka mniejszych paczek.. Kiedy będziesz gotowy, wywołaj
git format-patch master..devel
Utworzy to kilka plików z nazwami w rodzaju 0001-Commit-title.patch.

Wysyłając nam kod, wysyłaj albo podpisane patche albo podpisany
pull request. Niepodpisane zmiany nie zostaną zaakceptowane. Podpisanie oznacza dodanie na końcu opisu linijki o treści „Signed-off-by: ImięNazwisko „, co oznacza, że to Ty jesteś autorem(-ką) kodu i masz prawo by udostępnić ten kod jako Open Source.

Zobacz też: Signed-off-by Lines

Proszę, pisz dobre opisy zmian.
Dobry opis wygląda następująco:

Nagłówek: podsumowanie zmian w jednej linijce

Ciało opisu to kilka linijek tekstu opisujące zmiany
bardziej szczegółowo, opcjonalnie z podaniem powodów zmian etc…

Ciało komentarza może mieć kilka paragrafów.
Proszę podziel je tak, by linie tekstu nie miały więcej niż
około 74 znaki. Dzięki temu „git log” będzie je wyświetlał
poprawnie.

Repoted-by: ktokolwiek-zgłosił-problem
Signed-off-by: Twoje Imię i Nazwisko <twój_email@twójhost.com>

nagłówek powinien być sensowny i naprawdę mieć tylko jedną linię.
Ta linijka jest wyświetlana przez narzędzia takie jak gitk i shortlog
i powinna jedynie podsumowywać zmiany, szczegóły podaj w ciele komentarza.

gitk sample

Przykład z użyciem gitk