Документация Python неофициальный перевод
Содержание страницы

Работа с ошибкамиDealing with Bugs

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

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

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

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

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

См. также

Ошибки в документации на трекере задач Python

Использование трекера ошибок PythonUsing the Python issue tracker

Отчёты об ошибках для самого Python следует отправлять через трекер ошибок GitHub (https://github.com/python/cpython/issues). Трекер ошибок GitHub предоставляет веб-форму, в которую можно ввести необходимую информацию и отправить её разработчикам.

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

Если проблема, о которой вы сообщаете, ещё не в списке, войдите в GitHub. Если у вас ещё нет учётной записи GitHub, создайте новую с помощью ссылки «Sign up». Невозможно отправить отчёт об ошибке анонимно.

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

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

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

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

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

См. также

Как эффективно сообщать об ошибках

Статья, которая подробно описывает, как составить полезный отчёт об ошибке. В ней объясняется, какая информация полезна и почему.

Рекомендации по написанию отчетов об ошибках

Информация о том, как написать хороший отчёт об ошибке. Некоторые моменты относятся к проекту Mozilla, но описываются общие хорошие практики.

Начало работы над собственным вкладом в PythonGetting started contributing to Python yourself

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