Работа с ошибками¶
Python - это зрелый язык программирования, завоевавший репутацию благодаря своей стабильности. Для поддержания такой репутации разработчики хотели бы знать о любых найденных вами в Python недочётах.
Иногда бывает быстрее самостоятельно исправить ошибки и внести патчи в Python, так как это упрощает процесс и вовлекает меньше людей. Узнайте, как внести свой вклад.
Ошибки в документации¶
Если вы нашли ошибку в этой документации или хотели бы предложить улучшение, пожалуйста, отправьте отчёт об ошибке в систему отслеживания ошибок. Если у вас есть предложение по её исправлению, включите его также.
Если ошибка или предложение по улучшению касается перевода этой документации, отправьте отчёт в репозиторий перевода.
Вы также можете начать обсуждение на нашем форуме Documentation Discourse.
Если вы обнаружили ошибку в теме (HTML / CSS / JavaScript) документации, отправьте отчёт об ошибке в систему отслеживания ошибок python-doc-theme.
См. также
- Ошибки в документации
Список ошибок в документации, которые были отправлены в систему отслеживания ошибок Python.
- Система отслеживания ошибок
Обзор процесса отправки улучшений через трекер.
- Помощь с документацией
Подробное руководство для тех, кто хочет внести свой вклад в документацию Python.
- Documentation Translations
A list of GitHub pages for documentation translation and their primary contacts.
Использование системы отслеживания ошибок 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.