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

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, создайте её, нажав ссылку «Sign up». Отправить сообщение об ошибке анонимно нельзя.

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

В форме отправки есть два поля: «Title» и «Comment».

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

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

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

См. также

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

Как начать самостоятельно вносить вклад в Python

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