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

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

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

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

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

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

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

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

См. также

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

Список ошибок в документации, которые были отправлены в трекер ошибок Python.

Отслеживание ошибок

Обзор процесса, связанного с сообщением об улучшении в трекере.

Помощь с документацией

Исчерпывающее руководство для желающих внести вклад в документацию Python.

Переводы документации

Список страниц GitHub для перевода документации и их контактные лица.

Использование трекера ошибок 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.