Przejdź do treści

Przewodnik po sprincie

Witamy w BeeWare Sprints!

Witamy! Cieszymy się, że zdecydowałeś się do nas dołączyć! Jeśli jeszcze jeszcze nie przedstawiłeś się jednemu z członków zespołu Bee, zrób to. Po Gdy już to zrobisz, wróć tutaj, aby rozpocząć.

Czym jest sprint?

Sprint to nieustrukturyzowana okazja do spędzenia kilku godzin lub dni na pracując wspólnie nad projektem Open Source. Często są one powiązane z z konferencją; sprint po konferencji stanowi okazję do przekształcenia energii, entuzjazmu i zainteresowania, które wygenerowała konferencja w ulepszenia oprogramowania, z którego korzystamy na co dzień.

Sprinty są również okazją do wprowadzenia ludzi w proces współtworzenia projektu. Mamy nadzieję, że będziesz się tak dobrze bawić podczas sprintu, że wrócisz do domu i będziesz kontynuować wnosić swój wkład!

Nie ma znaczenia, ile masz doświadczenia. Podczas poprzednich sprintów połączyliśmy wkłady osób o różnym poziomie doświadczenia – uczniów szkół średnich, absolwentów bootcampów, osób, które nie uważają się za programistów, oraz doświadczonych programistów. Niezależnie od Twojego poziomu doświadczenia – znajdziemy sposób, abyś mógł wnieść swój wkład.

Kod to nie jedyny sposób, w jaki można wnieść swój wkład. Projekt taki jak BeeWare to znacznie więcej niż tylko kod - potrzebujemy ludzi do pisania, korekty i tłumaczenia dokumentacji; potrzebujemy ludzi do poprawy projektowania stron internetowych; nawet proces przechodzenia przez błędy, które zostały zgłoszonych lata temu i ustalanie, czy zostały one naprawione po drodze jest cennym wkładem.

Pytania wstępne

Aby rozpocząć, zadamy kilka pytań, abyśmy mogli ocenić Twoje zainteresowania i doświadczenie. Pomoże nam to znaleźć najlepszy sposób na wniesienie swojego wkładu. Przeanalizuj pytania, zrób notatki, a następnie znajdź członka Bee Team i podziel się swoimi odpowiedziami. Jeśli nie rozumiesz pytania - nie przejmuj się tym! Daj nam znać, co co wiesz, a my będziemy pracować razem, aby to rozgryźć.

  1. Czy korzystałeś już wcześniej z BeeWare?

Jeśli jeszcze tego nie zrobiłeś, zacznij od przejścia przez samouczek BeeWare. Zapozna Cię on z projektem BeeWare i pokaże, jak poszczególne jego elementy do siebie pasują. Jeśli podczas wykonywania samouczka napotkasz jakieś problemy, zanotuj je — ponieważ upewnienie się, że nikt inny nie ma tego samego problemu, to świetny temat na pierwszy wkład w projekt!

Po ukończeniu samouczka co najmniej do kroku 4 przejdź do następnego pytania.

  1. Jakie urządzenia komputerowe masz ze sobą?

Sprzęt, który posiadasz, nakłada praktyczne ograniczenia na to, w czym możesz pomóc. Na przykład, jeśli masz laptopa z systemem Windows, nie będziesz w stanie pracować nad niczym, co ma związek z systemem iOS. Czy Twój laptop działa pod kontrolą systemu Windows, macOS, Linux czy innego? Czy Twój telefon to urządzenie z systemem iOS czy Android? Czy Twoje urządzenia zostały dostarczone przez pracodawcę, czy są to Twoje urządzenia osobiste?

  1. Jakie masz doświadczenie w pisaniu kodu w języku Python?

Jesteś początkującym programistą? Weteranem języka Python? Weteranem kodowania, który dopiero zaczął naukę języka Python? Świeżo upieczonym absolwentem programu bootcamp? Chcemy znaleźć problem, który będzie dobrze dopasowany do Twojego poziomu doświadczenia.

  1. Czy znasz procesy związane z wkładem w GitHub?

Czy korzystasz z serwisu GitHub (lub podobnej witryny służącej do udostępniania kodu) w celu hostowania własnego kodu lub współtworzenia projektów innych osób? Czy wiesz, czym jest CI (ciągła integracja)? Czy brałeś udział w projekcie, który wykorzystuje haki pre-commit? Gdybym poprosił Cię o „rebase swój PR względem main”, czy wiedziałbyś, co należy zrobić?

  1. Czy brałeś już kiedyś udział w projekcie Open Source?

Czy brałeś kiedyś udział w sprincie? Czy kiedykolwiek wysłałeś PR (pull request) do projektu Open Source? Czy wiesz, jak używać GitHub do tworzenia pull requestów?

  1. Czy posiadasz inne specjalne umiejętności, które mogą się przydać?

Czy znasz API GUI (takie jak WinForms, Cocoa lub GTK)? Czy masz dogłębną wiedzę na temat wewnętrznej struktury konkretnego systemu operacyjnego? Czy jesteś ekspertem w języku programowania innym niż Python? Jeśli nie masz żadnych specjalnych umiejętności, nie ma problemu — ale jeśli mamy do czynienia z guru systemu Windows, chcemy mieć pewność, że te umiejętności zostaną dobrze wykorzystane.

  1. Dlaczego dołączyłeś do nas i czym się interesujesz?

„Wydawało mi się, że to fajny projekt” to całkiem dobra odpowiedź. Jeśli jednak masz inne powody, dla których do nas dołączyłeś, daj nam znać. Interesujesz się tworzeniem aplikacji mobilnych czy stacjonarnych? Pakowaniem? Stronami internetowymi? Aplikacjami konsolowymi? Jeśli nie masz konkretnych zainteresowań – co wydaje Ci się najciekawsze na podstawie tego, co do tej pory widziałeś w BeeWare?

Teraz znajdź członka zespołu Bee Team, aby podzielić się swoimi odpowiedziami. Mogą zadać zadać kilka dodatkowych pytań; ale wtedy wskażą ci kierunek obszar, w którym powinieneś być w stanie wnieść swój wkład.

Znajdź swój problem

Jeśli rozmawiałeś z członkiem zespołu Bee, prawdopodobnie wskazał ci on część projektu BeeWare, w której możesz wnieść swój wkład; być może zasugerował nawet konkretną kwestię, nad którą możesz popracować. Jeśli nie podał ci konkretnej kwestii, prawdopodobnie wskazał ci „Good First Issues” dla tego projektu. Co to oznacza?

GitHub udostępnia listę problemów, która pozwala BeeWare (i innym projektom) śledzić wszystkie zgłoszone problemy. projektom) śledzenie wszystkich zgłoszonych problemów - w tym Obejmuje to jawne błędy, nieoczekiwane zachowanie, które może być błędem, prośby o nowe funkcje, prośby o więcej dokumentacji - wszystko co może być sposobem na ulepszenie BeeWare. W miarę zgłaszania nowych błędów zgłoszone, zespół Bee oznaczy niektóre z nich jako sprawy, które są dobrze dobrze nadają się dla osób, które po raz pierwszy wnoszą swój wkład - sprawy, które nie wymagają natychmiastowej poprawki, ale są dobrze zdefiniowane lub łatwe do odtworzenia i prawdopodobnie mają dobry trop co do przyczyny. Problemy te są oznaczone jako "dobry pierwsza sprawa", aby ułatwić ich znalezienie.

Aby przefiltrować listę zgłoszeń GitHub według etykiety „good first issue”, wykonaj następujące czynności:

  1. Kliknij przycisk „Etykiety” nad listą problemów, aby aktywować menu rozwijane.
  2. Wpisz słowo „dobry” w polu wyszukiwania u góry menu rozwijanego.
  3. Kliknij „dobry pierwszy numer” na filtrowanej liście.

Filtrowanie zgłoszeń GitHub według
etykiet

Filtrowanie zgłoszeń GitHub według etykiety „good first issue” (dobry pierwszy problem).

Po znalezieniu zagadnienia, które wydaje się interesujące, przeczytaj wszystkie komentarze do postu i opublikuj komentarz w dyskusji, mówiąc, że że przyglądasz się temu zagadnieniu (np. "Przyglądam się temu podczas sprintów PyCon US 2025"). BeeWare nie "przydziela" zgłoszeń - przyjmujemy zgłoszenia od każdego. od każdego. Jednak w sytuacji sprintu musimy upewnić się, że nie skończymy z dwiema osobami pracującymi nad tym samym zagadnieniem. nad tym samym zagadnieniem - pozostawienie komentarza jest lekkim sposobem na koordynację między współtwórcami. współtwórcami.

Jeśli nadal nie możesz znaleźć niczego, co chciałbyś zrobić, znajdź członka Bee Team a oni pomogą ci zawęzić do konkretnej kwestii.

Skonfiguruj środowisko programistyczne

Po znalezieniu błędu należy skonfigurować środowisko programistyczne aby móc pracować nad poprawką. Każdy projekt BeeWare ma swój własny przewodnik:

Jeśli projektu nie ma na tej liście, sprawdź README projektu, aby uzyskać szczegółowe informacje jak go skonfigurować. Jeśli którakolwiek z instrukcji nie ma sensu (lub nie możesz znaleźć tych instrukcji), znajdź członka zespołu Bee Team, a a oni ci pomogą. A jeśli uważasz, że możesz poprawić instrukcje, aby inne osoby nie napotkały tego samego problemu, ulepszenie jest cennym wkładem!

Teraz możesz zacząć pracować nad swoim problemem!

Co się stanie po złożeniu wniosku o PR?

Po przesłaniu pull requesta i przejściu przez niego wszystkich automatycznych kontroli wszystkie automatyczne kontrole, jesteś gotowy do przeglądu. Poinformuj jednego z członków zespołu zespołu, że masz PR gotowy do przeglądu, a oni się nim zajmą. przyjrzy.

Jeśli jest to twój pierwszy PR, jest całkiem prawdopodobne, że recenzja znajdzie pewne problemy. problemy. Może to być przypadek brzegowy, którego nie wziąłeś pod uwagę, lub konwencja konwencja kodu, której nie przestrzegałeś. Nie zniechęcaj się! Nikt - nawet nawet główny zespół - nie otrzymuje PR-ów w 100% poprawnych za pierwszym razem.

Gdy PR przejdzie przegląd, recenzent połączy PR – i gotowe! Gratulacje – przyczyniłeś się do rozwoju BeeWare! Jeśli jest to Twój pierwszy wkład w BeeWare, zdobyłeś również BeeWare Challenge Coin – znajdź członka głównego zespołu, a otrzymają Ci monetę!

Pomocy! Utknąłem!

Jeśli utkniesz w jakimkolwiek punkcie po drodze, znajdź członka zespołu Bee Team. Nie bój się zadać każdego pytania. Jeśli utkniesz, chcemy Cię z niego wyciągnąć. Jeśli jesteś zdezorientowany, to dlatego, że temat jest skomplikowany, a my nie wyjaśniliśmy go wystarczająco dobrze. Jesteśmy chętni do pomóc - i chcemy mieć pewność, że sprint zakończy się sukcesem.

Co się stanie, jeśli nie zrealizuję swojego wkładu podczas sprintu?

Nie ma problemu! Możesz przesłać swój wkład w dowolnym momencie. Celem sprintów jest zachęcenie Cię do dalszego udziału w projekcie przez resztę roku. Zespół Bee Team służy pomocą w każdym etapie tego procesu.

Jeśli już pracowałeś nad problemem GitHub lub przesłałeś PR, możesz kontynuować komunikację za pośrednictwem GitHub. Jeśli masz inne pytania lub potrzebujesz pomocy w czasie rzeczywistym, najlepszym miejscem, aby nas znaleźć, jest serwer BeeWare Discord. Cieszymy się na dalszą współpracę z Tobą!

Ulepszanie niniejszego przewodnika

Jeśli masz jakieś sugestie, jak ulepszyć ten przewodnik po sprincie, daj nam znać. Co się sprawdziło? Co się nie sprawdziło? Co możemy zrobić lepiej? I pamiętaj: naprawienie problemu z tym przewodnikiem liczy się jako wkład w BeeWare!