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

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

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

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

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

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

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

См. также

Ошибки в документации: Список ошибок документации, отправленных в систему отслеживания ошибок 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.