Identyfikowanie potencjalnych obszarów kontrybucji

Zakończone

W tej lekcji omówimy, jak rozpocząć pracę z udziałem open source. Spróbujemy też znaleźć zadania do współtworzenia, wyszukując problemy i tagi.

Oprogramowanie typu open source może być swobodnie używane, modyfikowane i udostępniane przez wszystkich użytkowników. Korzystając z oprogramowania open source, każdy może wyświetlać, modyfikować i rozpowszechniać projekt w dowolnym celu. Ideą oprogramowania open source jest to, że udostępnianie kodu prowadzi do lepszego, bardziej niezawodnego oprogramowania.

Istnieje wiele sposobów współtworzenia projektów open-source. Tworzenie pierwszego wkładu może być często przerażającym doświadczeniem, ale nie powinno być. Projekt open-source to miejsce dla każdego, gdzie kontrybucje są wprowadzane na każdym poziomie.

Znajdowanie projektu open-source wymagającego kontrybucji

Na początek warto zastanowić się nad projektami, z których już korzystano lub które mogą być warte skorzystania. Współtworzenie jest łatwiejsze, gdy znasz projekt i jego społeczność.

Być może podczas odczytywania pliku README projektu znajdziesz uszkodzony link lub literówki. Być może zauważysz, że coś nie działa zgodnie z oczekiwaniami lub dokumentacja jest nieaktualna. Są to doskonałe okazje do zaoferowania pomocy i współtworzenia projektu.

Napiwek

Jedną z ważnych wskazówek: Wszelkiego rodzaju wkłady są cenne. Twój poziom doświadczenia lub znajomości projektu nie ma znaczenia. Wszyscy możemy coś od siebie dodać. Uwierz w swoje możliwości. Najważniejsza jest chęć pomagania.

Korzystanie z funkcji wyszukiwania w usłudze GitHub

Funkcja wyszukiwania w usłudze GitHub może ułatwić eksplorowanie tematów i powiązanych projektów. Przejdź do wyszukiwania w usłudze GitHub i wprowadź słowo tematu.

Załóżmy, że interesuje Cię uczenie maszynowe.

Następnie możesz zawęzić wyszukiwanie, wybierając pozycję Tematy na lewym pasku bocznym.

W ten sposób możesz znaleźć repozytoria związane z wyszukiwanym słowem kluczowym oraz repozytoria nadzorowane przez członków społeczności.

Zapoznawanie się z projektem open-source

Warto zauważyć, że każda społeczność open-source jest inna. Po znalezieniu projektu, musisz się z nim zapoznać oraz przeczytać wytyczne dotyczące uczestnictwa w nim.

W przypadku większości projektów na najwyższym poziomie repozytorium będą się znajdować następujące dokumenty:

• LICENCJA: Projekt musi zawierać licencję typu open source. Jeśli projekt nie ma licencji, nie jest projektem open-source.
• README: Plik README zwykle służy jako strona powitalna projektu. Zazwyczaj zawiera on informacje na temat rozpoczynania pracy z projektem. Często w tym dokumencie można też znaleźć informacje dotyczące sposobu dołączenia do społeczności.
• PRZYCZYNIAJĄC SIĘ: Jak sugeruje jego nazwa, ten dokument zawiera wskazówki dotyczące współtworzenia projektu. Zwykle opisuje sposób działania procesu współtworzenia i zawiera szczegółowe informacje na temat sposobu konfigurowania środowiska deweloperskiego.
• CODE_OF_CONDUCT: Kodeks postępowania określa podstawowe zasady dla członków społeczności. Postępowanie według tych reguł pomaga zapewnić bezpieczne i przyjazne środowisko dla wszystkich.

Chociaż nie we wszystkich projektach znajdują się dokumenty CONTRIBUTING (Współtworzenie) i CODE_OF_CONDUCT (Kodeks postępowania), ich obecność jest dobrym wskaźnikiem przyjazności projektu.

Współautorzy i osoby odpowiedzialne za projekt mogą pochodzić z dowolnego miejsca na świecie. Projekty mają zwykle wiele kanałów komunikacyjnych służących do organizowania dyskusji i zwracania się o pomoc. Dobrym sposobem zaznajomienia się ze społecznością jest przejrzenie niektórych z tych kanałów komunikacyjnych:

• Śledzenie problemów: Gdzie ludzie dyskutują o problemach i zadaniach związanych z projektem. Aby znaleźć problemy w usłudze GitHub, możesz przejść do strony głównej repozytorium w usłudze GitHub i dodać /issues go na końcu adresu URL, na przykład: https://github.com/jupyter/notebook/issues.
• Żądanie ściągnięcia: Gdzie ludzie dyskutują i przeglądają zmiany w projekcie. Ten kanał można znaleźć w usłudze GitHub, dodając ciąg pulls do adresu URL projektu (na przykład https://github.com/jupyter/notebook/pulls).
• Kanały czatów i fora: Niektóre projekty korzystają z kanałów czatów, takich jak Slack, Gitter i IRC, lub forów, takich jak Dyskurs do rozmów i dyskusji.

Identyfikowanie zadań, nad którymi można pracować

Udało Ci się znaleźć projekt, zapoznaliśmy się z wytycznymi dotyczącymi współtworzenia, a teraz wszystko jest gotowe do współtworzenia.

Być może zidentyfikowano już coś do wykonania, na przykład naprawianie uszkodzonych linków lub aktualizowanie dokumentów. Dobrym sposobem znalezienia problemów przyjaznych dla początkujących jest zapoznanie się z adresem URL projektu /contribute , na przykład: https://github.com/jupyter/notebook/contribute.

Większość problemów wyświetlanych na stronie spod adresu URL contribute będzie miała etykiety, takie jak good-first-issue, help wanted, beginner-friendly i tak dalej. Etykiety są często używane do udostępniania najważniejszych informacji o problemie i typie wymaganej pomocy.

Możesz przejść do strony etykiet, na przykład: https://github.com/jupyter/notebook/labels. Następnie wybierz problemy, które mają etykiety, takie jak help wanted, discussionlub inne etykiety dotyczące typu udziału, w którym cię interesuje.

W miarę eksplorowania problemów można również zauważyć, że niektóre z nich mają powiązane inne problemy lub żądania ściągnięcia.

Sponsorowanie projektu

Istnieje wiele sposobów współtworzenia projektów open-source. Możesz wesprzeć finansowo osoby, które tworzą i utrzymują ekosystem open-source za pomocą kodu, umiejętności kierowniczych i projektowych, wsparcia mentorskiego i nie tylko.

Projekty open-source są w większości oparte na pracy wolontariuszy. Sponsorzy serwisu GitHub umożliwiają finansowanie projektów i osób. Dzięki temu mogą one kontynuować swoją pracę nad projektami open-source, mając poczucie, że ich działania przynoszą im uznanie, na jakie zasługują.

Jeśli projekt kwalifikuje się do dostępu sponsorowanego za pośrednictwem sponsorów GitHub, na stronie głównej projektu znajdziesz przycisk Sponsor .

Możesz wybrać warstwę sponsorowania i zdecydować, czy Twoja kontrybucja ma być publiczna.

Podsumowanie lekcji

W tej lekcji omówiono sposób rozpoczęcia pracy z kontrybucjami open-source. Teraz wiesz już, jak wybrać projekt, nad którym chcesz pracować, i jak korzystać z problemów i etykiet w witrynie GitHub, aby identyfikować zadania do wykonania.

Oto lista kontrolna przydatna podczas korzystania z projektu po raz pierwszy:

• Czy projekt ma licencję?
• Czy osoby odpowiedzialne i współautorzy aktywnie prowadzą dyskusje na temat problemów i żądań ściągnięcia?
• Czy w projekcie są używane etykiety przeznaczone dla początkujących użytkowników, takie jak help wanted lub good first issue?
• Czy projekt ma kodeks postępowania?
• Czy projekt ma jasne wskazówki dotyczące współtworzenia?

Na koniec pamiętaj, że wszystkie kontrybucje są mile widziane oraz że ekosystem open-source znacznie zyskuje dzięki Twoim pomysłom i udziałowi. Istnieje wiele sposobów na przyczynienie się do rozwoju projektów open-source — od przesyłania kodu lub angażowania się w dyskusje na temat projektu do sponsorowania projektów za pośrednictwem programu sponsorów usługi GitHub.