Bugzilla/Bug report guide/ru

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

Лучшие практики

 * Перечитайте текст отчета перед отправкой; текст нельзя отредактировать впоследствии. Текст отчета об ошибке, как правило, немедленно отправляется по электронной почте множеству людей. Напишите отчет ясно, на чистом языке; избегайте разговорной лексики. Подсказка: Представьте, что у вас есть только один шанс в вашей жизни, чтобы написать этот очень важный отчет об ошибке. Вы должны понимать, что получатель может прочитать по-английски, но это может быть не его родной язык.


 * Поищите дубликаты, перед созданием нового бага.


 * Не отклоняйтесь от темы. — bug ticket предназначен для технических отчетов, а не для болтовни. Оставьте ее для каналов поддержки (форумы, IRC и списков рассылок).
 * Подтверждайте существование проблемы только один раз. — Если вы и кто-то другой сообщите дважды о той же самой проблеме, это не поспособствует ее решению. Однако, если ваша система очевидно отличается от системы подтвердившего ошибку, и это имеет значение, тогда добавьте эту информацию.
 * Открывайте один отчет для каждой проблемы — Если ваша проблема не обсуждается в отчете, поищите отчет, имеющий к ней отношение или создайте новый. Не захватывайте другие отчеты об ошибках.
 * Никаких разговоров в TRACKER bugs. — Эти отчеты являются мета-отчетами. Если вы хотите добавить полезную информацию, добавьте ее в подходящий суб-отчет или создайте новый отчет.

Дополнительно: поддержка Gentoo на коммерческой основе
Если вам необходима коммерческая помощь с ошибками, с любыми проблемами в Gentoo, или необходим новый ebuild, посмотрите на список профессиональных консультантов Gentoo.

Packages/ebuild
Вы должны всегда добавлять информацию о системной конфигурации в баг. Для этого создайте новое вложение (attachment) и вставьте содержимое:

Сообщите об ошибке во время сборки (emerge failed)

 * Сперва напишите точную версию пакета в заголовке отчета, например sys-apps/package-2.3-r4
 * Добавьте в заголовок краткое сообщение ошибки
 * Прикрепите (attach) файл журнала в
 * Если файл журнала слишком велик для загрузки, сожмите его: и загрузите build.log.xz
 * Прикрепите вывод команды

Сообщите об ошибках во время выполнения
Файлы и информация, представляющая интерес, в порядке приоритета:


 * Точная версия пакета в заголовке отчета, например sys-apps/package-2.3-r4 аварийно завершается с ошибкой: Не могу продолжать...
 * Описание проблемы, чтобы другие могли ее воспроизвести:
 * Как запускается программа (в консоли, в терминале, в качестве демона, в каком уровне запуска и так далее)
 * Какие ошибки выводятся
 * Что заставляет программу аварийно завершаться, неправильно работать, не запускаться
 * Есть ли возможность обойти проблему?
 * Последняя версия пакета, которая работала нормально, если таковая была
 * Какие изменения привели к тому, что программа перестала работать?
 * Прикрепите вывод команды emerge --info
 * Прикрепите вывод команды emerge -pv  для быстрого просмотра зависимостей

Сообщить о новой версии; новая версия программы доступна какое-то время

 * Search Bugzilla before posting a bump request - is there already a bug open? Has the local Portage tree been synced lately; is it already in Portage?
 * Avoid Zero-day bump requests (wait at least 48 hours after the release announcement)
 * Has it actually been released by upstream sources, or is it just marked in the source tree? Some projects mark a release in the tree long time before it is officially released.
 * Be sure to mention if it compiles and runs well on your arch. Any other helpful information you provide is most welcome.
 * Add a link to the upstream website
 * Give a link or list of fixed bugs or new features (sometimes called changelog)
 * Write a title in the form app-editors/vim-12.3.5 version bump

Не обязательно

 * Требуются ли изменения в ebuild? (изменение зависимостей, удаление устаревших patch-фалов)
 * Если новая версия не требует изменения содержимого файла ebuild, отметьте это
 * Протестируйте файл ebuild в локальном оверлее перед тем как прикрепить и отправить его
 * Предоставьте патчи для предложенных изменений файла ebuild, по желанию, с объяснением изменений (имя файла должно соответствовать новому номеру версии, не старому)
 * Предоставьте дополнительные файлы (initd, unit-файлы) в качестве отдельных прикреплений (по необходимости)
 * Не вставляйте файлы ebuild или другое содержимое, относящееся к ним, прямо в комментарии; используйте прикрепления

Запрос на добавление нового пакета; запрос ebuild файла
Если вы хотите добавить в Portage новый ebuild для какой-либо программы, вам нужно найти куратора (maintainer) для пакета, либо самому им стать:


 * Link to the upstream website in the bug report
 * Give a link or list of features
 * Suggest a preliminary category and package name for the ebuild in the subject line for example "media-gfx/inkscape ebuild request"
 * Provide an ebuild and patches that were tested in your local overlay (you can get help in IRC or in the forums with that)

Пакет XY следует отметить как стабильный
Пакет собирается и работает без проблем более 30 дней, но все еще отмечен как нестабильный:


 * Более подробную информацию о стабильной/нестабильной ветвях можно найти в статье KEYWORDS
 * Вы тщательно оттестировали версию, которую вы хотите сделать стабильной?
 * Существуют другие отчеты, относящиеся к этой ошибке?
 * Версия пакета была добавлена как минимум 30 дней назад?
 * Все зависимости этой версии отмечены, как стабильные?

Ядро
Файлы и информация, представляющая интерес для отчетов об ошибках ядра, в порядке приоритета:


 * Какая версия ядра используется, на какой архитектуре, например gentoo-sources-3.4.2-r2 на x86_64
 * Файл конфигурации ядра следует прикрепить к отчету:
 * Список всех устройств в системе можно получить с помощью команды lspci -k
 * Следует прикрепить файлы журналов ядра, содержащие информацию о его инициализации: или

Другие отчеты об ошибках
Тут нет шаблонов, это относится к категории проблем вроде тех, которые возникают с captcha на wiki.gentoo.org, forum.gentoo.org недоступен, или к любым другим проблемам, не относящимся к программному обеспечению.

Смотрите также

 * Руководство по Bugzilla
 * Как помочь Gentoo
 * Запрос о стабилизации
 * Gentoo Github — Как помочь проекту Gentoo и отправить Pull Request via GitHub

Внешние ресурсы

 * Сайт Gentoo Bugzilla