Работа с ошибками

Python — зрелый язык программирования, заслуживший репутацию стабильного. Чтобы поддерживать эту репутацию, разработчикам важно знать о любых недостатках, которые вы обнаружите в Python.

Иногда быстрее исправить ошибки самостоятельно и предложить исправления для Python: это упрощает процесс и позволяет привлечь меньше людей. Узнайте, как участвовать в разработке.

Ошибки в документации

Если вы обнаружили ошибку в этой документации или хотите предложить улучшение, отправьте сообщение об ошибке в трекер. Если у вас есть предложение по её исправлению, добавьте его тоже.

Вы также можете начать обсуждение на нашем форуме Documentation Discourse.

Если вы обнаружили ошибку в теме оформления документации (HTML / CSS / JavaScript), отправьте сообщение об ошибке в трекер ошибок python-doc-theme.

Если у вас мало времени, вы также можете отправить сообщения об ошибках в документации по электронной почте на адрес docs@python.org (о поведенческих ошибках можно сообщить на адрес python-list@python.org). ‘docs@’ — это список рассылки, который ведут добровольцы; ваше сообщение заметят, хотя его обработка может занять некоторое время.

См. также

Ошибки в документации: Список ошибок в документации, отправленных в трекер проблем Python.
Отслеживание проблем: Обзор процесса отправки предложения по улучшению в трекер.
Помощь с документацией: Подробное руководство для тех, кто хочет участвовать в работе над документацией Python.
Переводы документации: Список страниц GitHub, посвящённых переводу документации, и контакты основных ответственных.

Использование трекера проблем Python

Сообщения о проблемах в самом Python следует отправлять через трекер GitHub (https://github.com/python/cpython/issues). В трекере GitHub есть веб-форма, позволяющая ввести необходимые сведения и отправить их разработчикам.

Первый шаг при отправке сообщения — выяснить, сообщал ли кто-нибудь об этой проблеме ранее. Это сэкономит время разработчиков и позволит узнать, что уже было сделано для её исправления; возможно, проблема уже исправлена в следующем выпуске или нужны дополнительные сведения (в этом случае вы можете предоставить их, если это возможно!). Для этого выполните поиск в трекере с помощью поля поиска в верхней части страницы.

Если сообщаемой вами проблемы ещё нет в списке, войдите в GitHub. Если у вас ещё нет учётной записи GitHub, создайте её, нажав ссылку «Зарегистрироваться». Отправить сообщение об ошибке анонимно нельзя.

После входа в систему вы можете отправить сообщение о проблеме. Нажмите кнопку «Новая проблема» на верхней панели, чтобы сообщить о новой проблеме.

Форма отправки содержит два поля: «Заголовок» и «Комментарий».

В поле «Заголовок» введите очень краткое описание проблемы; желательно использовать менее десяти слов.

В поле «Комментарий» подробно опишите проблему, указав, что вы ожидали и что произошло на самом деле. Обязательно укажите, использовались ли какие-либо модули расширения, а также оборудование и программную платформу (при необходимости — с указанием версий).

Каждое сообщение о проблеме будет рассмотрено разработчиком, который определит, что нужно сделать для её исправления. Вы будете получать уведомление каждый раз, когда по проблеме будут предприняты какие-либо действия.

См. также

Как эффективно сообщать об ошибках: Статья с подробным описанием того, как составить полезное сообщение об ошибке. В ней рассказывается, какие сведения полезны и почему.
Рекомендации по составлению сообщений об ошибках: Сведения о том, как правильно составить сообщение об ошибке. Некоторые рекомендации относятся только к проекту Mozilla, но в целом описывают хорошие практики.

Как начать самостоятельно участвовать в разработке Python

Помимо сообщений об обнаруженных ошибках, вы можете отправлять исправления для них. Дополнительные сведения о том, как начать вносить исправления в Python, приведены в руководстве разработчика Python. Если у вас есть вопросы, список рассылки core-mentorship — дружелюбное место, где можно получить ответы на любые вопросы, связанные с процессом исправления проблем в Python.