Zajmowanie się błędami¶
Python jest dojrzałym językiem programowania, z ustaloną reputacją swojej stabilności. Aby utrzymać tę stabilność, deweloperzy chcieliby wiedzieć o wszelkich brakach, które da się znaleźć w Pythonie.
Czasem szybsze może być własnoręczne naprawienie błędu i wysłanie patchy do Pythona, usprawnia to proces i angażuje mniej osób. Dowiedz się, jak kontrybuować.
Błędy w dokumentacji¶
Jeśli znajdziesz błąd w tej dokumentacji lub chciałbyś zaproponować poprawkę, wyślij, prosimy, zgłoszenie błędu do systemu. Jeżeli błąd dotyczy jedynie polskiego tłumaczenia, zgłoś błąd pod adresem: https://github.com/python/python-docs-pl. Jeśli masz sugestię, jak naprawić błąd, zawrzyj ją w zgłoszeniu.
Możesz również otworzyć dyskusję na naszym forum Discourse dokumentacji.
Jeśli znajdziesz błąd w motywie (HTML / CSS / JavaScript) dokumentacji, zgłoś raport o błędzie w projekcie python-doc-theme.
Jeśli brakuje ci czasu, możesz też wysyłać zgłoszenia błędów w dokumentacji na docs@python.org (błędy behawioralne mogą być wysyłane na python-list@python.org). «docs@» jest listą mailingową prowadzoną przez wolontariuszy; twoje zgłoszenie zostanie zauważone, aczkolwiek jego przetworzenie może chwilę zająć.
Zobacz także
- Błędy w dokumentacji
Lista błędów w dokumentacji, które zostały wysłane do systemu zgłoszeń błędów Pythona.
- Śledzenie zgłoszeń
Omówienie procesu zgłaszania poprawki w systemie zgłoszeń.
- Pomoc w dokumentacji
Wyczerpujący przewodnik dla osób zainteresowanych rozwijaniem dokumentacji Pythona.
- Tłumaczenie dokumentacji
Lista stron GitHub do tłumaczenia dokumentacji i ich główne kontakty.
Używanie systemu zgłoszeń Pythona¶
Zgłoszenia błędów w Pythonie powinny być zgłaszane przez system zgłoszeń GitHub (https://github.com/python/cpython/issues). System zgłoszeń GitHub posiada formularz, który pozwala wprowadzić stosowne informacje i wysłać je deweloperom.
Pierwszym krokiem przy wypełnianiu zgłoszenia jest ustalenie, czy problem został już zgłoszony. Zaletą tego ustalenia, oprócz oszczędzenia czasu deweloperów, jest to, że dowiesz się, co zostało zrobione, aby go naprawić; być może problem został już naprawiony na następne wydanie lub potrzebne są dodatkowe informacje (w tym przypadku zapraszamy cię, żebyś je podał, jeśli możesz!). Aby to zrobić, przeszukaj istniejące zgłoszenia używając pola wyszukiwania na górze strony.
Jeśli problemu, który zgłaszasz, nie ma jeszcze na liście, zaloguj się do GitHuba. Jeśli nie masz jeszcze konta GitHub, stwórz nowe konto używając linku „Sign up”. Nie da się stworzyć zgłoszenia anonimowo.
Będąc zalogowanym możesz wysłać zgłoszenie. Kliknij przycisk „Nowe zgłoszenie” w górnym pasku, aby wysłać nowe zgłoszenie.
Formularz zgłoszenia ma dwa pola: „Tytuł” oraz „Komentarz”.
W polu „Tytuł” wpisz bardzo krótki opis problemu; najlepiej mniej niż dziesięć słów.
W polu „Comment” opisz problem szczegółowo, zawierając informacje o tym, czego się spodziewałeś, aby się stało i co się stało zamiast. Zawrzyj informację, czy dotyczy to jakiegokolwiek modułu rozszerzeń i platform hardware’owych i software’owych, których używałeś (oraz informacje o wersjach).
Każde zgłoszenie będzie zweryfikowane przez twórcę oprogramowania, który oceni, co musi być zrobione, aby naprawić problem. Otrzymasz aktualizację za każdym razem, gdy wobec zgłoszenia zostanie podjęte działanie.
Zobacz także
- How to Report Bugs Effectively
Artykuł, który dość szczegółowo opisuje, jak stworzyć wartościowe zgłoszenie błędu. Opisuje jakie rodzaje informacji są przydatne i dlaczego.
- Bug Writing Guidelines
Informacje o pisaniu dobrych zgłoszeń błędów. Niektóre z nich są specyficzne dla projektu Mozilla, ale opisują ogólne dobre praktyki.
Rozpoczęcie rozwijania Pythona samemu¶
Oprócz tylko zgłaszania błędów, które znajdziesz, jesteś również zaproszony do wysyłania patchy naprawiających je. Więcej informacji o tym, jak zacząć patchować Pythona, znajdziesz w Python Developer’s Guide. Jeśli masz pytania, lista mailingowa core-mentorship jest przyjaznym miejscem do uzyskiwania odpowiedzi na każde pytanie typowe dla procesu naprawiania błędów w Pythonie.