Как отправлять сообщения об ошибках? - ReactOS wiki

Эта статья рассказывает о том, как отправлять сообщения об ошибках в нашу систему отслеживания ошибок [http://reactos.org/bugzilla Bugzilla].

== Для чего нужно публиковать ошибки? ==

Иногда разработчики слишком заняты и не могут устранить найденные ошибки сразу после получения сообщения о них. Если Вы ограничитесь сообщением об ошибке в списке рассылки разработчиков или на нашем IRC-канале, то они (разработчики), возможно, не обратят внимание на ваше сообщение сразу, и подробности ошибки со временем могут быть утеряны. Запись ошибки в Bugzilla позволит Вам сообщить о проблеме способом, позволяющим дать разработчикам знать, что что-то не работает, при этом давая им время, чтобы закончить другие задачи, жить полной жизнью и т.д.

== Ошибки, о которых не нужно сообщать в Bugzilla ==

* Проблемы при сборке на основных платформах (Windows, Linux). Сообщайте о проблемах при сборке на IRC-канале, или в [http://www.reactos.org/?page=community_mailinglists списке рассылки разработчиков].

* Функции, которые ожидаются в следующих версиях Windows (WinFS, и т.д. ..)

== Обнаружили ошибку? ==

"ПРЕДУПРЕЖДЕНИЕ: ПРОЧТИТЕ ВНИМАТЕЛЬНО. НЕСОБЛЮДЕНИЕ СЛЕДУЮЩИХ ПРАВИЛ МОЖЕТ ПРИВЕСТИ К ИГНОРИРОВАНИЮ СООБЩЕНИЯ ОБ ОШИБКЕ И/ИЛИ СТАТЬ ПРИЧИНОЙ ПОМЕТКИ ЕГО, КАК НЕДОПУСТИМОГО. '"

'''[[User:Lone Rifle|Lone Rifle]] 14:13, 31 июля 2009 (UTC):' "Чтобы ограничить количество сообщений об ошибках, над которыми уже работают разработчики, пожалуйста, консультируйтесь с тестерами на IRC-канале, если Вы желаете оставить сообщение об ошибке, которая касается "установки или выполнения определенного приложения", или "запуска ReactOS на определенном компьютере, а не на средстве виртуализации, таком, как QEMU". Если Вы написали патч, или нашли точную причину ошибки '"'' (недостаточно просто воспроизвести ошибку! Вы должны будете объяснить, почему возникает эта ошибка!)' "'' и/или её решение, пожалуйста, опубликуйте ваше сообщение без нашей консультации. '"ReactOS находится в стадии альфа и ещё не готов для использования на Вашем основном компьютере. Разработчики не несут ответственности за потерю данных, кроме того, они не обязаны помогать Вам с Вашими проблемами.'"

Когда Вы думаете, что столкнулись с ошибкой, '"не сообщайте о ней немедленно'". Не беспокойте разработчиков на IRC (однако, можете побеспокоить тестеров). Прежде чем сообщить о чем-либо, вы должны удостовериться, что '"действительно'" нашли проблему. ReactOS полон случайных сбоев, странных эффектов и необъяснимых явлений, но нет ни малейшего смысла сообщать о них, поскольку они появляются и исчезают. Вам нужен'"основательный'" отчет с '"большим количеством информации'", в этом случае вы можете удостовериться в том, что ошибка реальна и вы не тратите впустую своё время и время разработчиков. Пожалуйста, следуйте нижеследующим рекомендациям, пункт за пунктом:

# Самое важное: Вы должны быть в состоянии воспроизвести эту ошибку. Если Вы не способны воспроизвести ошибку, не сообщайте о ней. Такое сообщение об ошибках зачастую бесполезно, поскольку разработчики должны наблюдать ту же самую проблему, которую видите Вы. Помните: продолжайте, '"только'" если Вы знаете, как воспроизвести ошибку!

# Зайдите на [http://www.reactos.org/bugzilla/ Bugzilla], и проверьте, не сообщал ли уже кто-либо об этой ошибке. Если сообщение об этой ошибке уже имеется, то не создавайте новый отчет, а просто добавьте Ваш собственный комментарий к существующей, подтвердите, что она имеет место и в Вашем случае, и, возможно, добавьте больше информации о ней (имеет смысл как минимум указать в комментарии номер ревизии, в который вы наблюдаете эту ошибку).

# Проверьте последнюю ([http://www.reactos.org/getbuilds/ основную]) ревизию '"ОТЛАДОЧНОГО ЗАГРУЗОЧНОГО ДИСКА'". Если эта проблема касается только сборок типа "релиз", пожалуйста, проконсультируйтесь с разработчиками. '"Мы не будем принимать сообщения об ошибках в официальных выпусках, то есть скачанных со страницы загрузки.'"

# Если Вы пользуетесь собственной сборкой ReactOS, то проверьте, пожалуйста, и [http://www.reactos.org/getbuilds/ официальную версию].

# Если Вы запускаете ReactOS на реальном оборудовании, попытайтесь [[Отладить]] его через нуль-модемный кабель. Это не обязательное требование для сообщения об ошибке, но это может значительно помочь при её исправлении. Если Вы не можете получить протокол отладки, будьте готовы к тому, что ошибка не привлечёт к себе внимания в течение долгого времени (пока кто-то другой не сможет предоставить данные для отладки, или ошибка не будет устранена случайно).

# Если Вы запускаете ReactOS на [[программа виртуализации|эмуляторе]], пожалуйста, имейте ввиду, что мы официально поддерживаем [[QEMU]], [[VMware]] и [[VirtualBox]]. Другие программы не поддерживаются, и Ваша ошибка, возможно, неправильна, поскольку она может быть следствием особенностями реализации конкретного эмулятора, для официальных же эмуляторов все такие особенности известны. Пожалуйста, проконсультируйтесь с нашими тестерами перед отправкой сообщения.

# Хорошей практикой могут стать консультации с другим [http://www.reactos.org/en/community_irc.html пользователями ReactOS]. Хотя это и не является обязательным, попробуйте попросить кого-нибудь подтвердить ошибку, повторив Ваши действия. После этого Вы точно можете сообщать об ошибке. Пожалуйста, прочтите раздел ниже для инструкций о публикации сообщений об ошибках.

# Беспокоить [[Люди ReactOS|разработчиков]] по поводу этой ошибки можно, только если она имеет серьезный эффект, например, прерывание процесса загрузки.

"НЕСОБЛЮДЕНИЕ СЛЕДУЮЩИХ ПРАВИЛ ПРИВЕДЁТ К ИГНОРИРОВАНИЮ СООБЩЕНИЯ ОБ ОШИБКЕ И/ИЛИ ПОМЕТКЕ ЕГО, КАК НЕДОПУСТИМОГО. '"

== Как создать хорошее сообщение об ошибке ==

=== Сбор информации ===

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

* '"Что Вы делали, когда случилась ошибка'"

:Это, вероятно, САМАЯ важная вещь, о которой вы должны сообщить. Если мы не сможем воспроизвести ошибку, то её будет почти невозможно диагностировать и исправить. Пожалуйста, потратьте немного своего времени на то, чтобы воспроизвести ошибку, прежде чем отправить отчёт о ней. Когда вы сможете последовательно воспроизвести её, напишите '"детализированный'" отчёт о том, как добиться её возникновения.

* '''Ваша аппаратная конфигурация'''

:Если Вы запускаете ReactOS на реальном компьютере, соберите информацию об особенностях аппаратной конфигурации. В Windows используйте стандартные средства: Менеджер Устройств, msinfo32, dxdiag и т.д. Если бы вы используете Linux, то можно начать с 'lspci' или 'cat /proc/pci'. Если Вы используете виртуальную машину, пожалуйста, укажите наименование/версию эмулятора. Это чрезвычайно важно в диагностировании ошибок загрузки или установки.

* '''Используемая вами версия ReactOS'''

:Если вы используете официальный выпуск, тогда мы должны знать его версию (например 0.3.7). Желательно использовать последнюю [http://www.reactos.org/getbuilds/ сборку транка] для того, чтобы удостовериться, что ошибка не была уже устранена. Если вы используете отладочную сборку из SVN, мы должны знать номер ревизии, его можно получить, введя команду 'ver' в командной строке ReactOS. Результатом выполнения команды 'ver' станет сообщение вроде "Version 0.4-SVN 20081029-r37042". Число rXXXXX - это номер ревизии, то есть, как раз то, что нам нужно.

* '"Любые отладочные сообщения, выводимые ReactOS'"

:Если у вас произошла критическая ошибка (BSOD), пожалуйста, потратьте немного времени на описание деталей ошибки. Регистрация данных отладки крайне важна, особенно для системных сбоев или сбоев прикладного программного обеспечения. Подготовьте и прикрепите файл отладки со своим сообщением об ошибках. <br/> Пожалуйста, изучите раздел [Отладка] для получения подробных сведений относительно сбора отладочной информации.

* '''Версия используемого вами приложения'''

:Если сбой связан с вашим любимым приложением windows, пожалуйста, сообщите, какую версию этого приложения вы используете, и откуда вы его загружали(добавьте на него ссылку).

* '''Скриншоты графических ошибок'''

:Лучше один раз увидеть, чем 100 раз услышать, а когда дело доходит до отладки графических проблем, возможно, что и не 100, а больше. Bugzilla позволяет вам прикреплять файлы к сообщениям об ошибках, так что если Вы можете получить скриншот ошибки, то, пожалуйста, сделайте его и приложите файл с ним к описанию ошибки. Имейте в виду, что загрузить ваше изображение (или, например, любое другое вложение) вы можете непосредственно в Bugzilla, без использования других служб загрузки или совместного использования.

=== Правила написания сообщений ===

Если у вас есть какие-нибудь вопросы или проблемы относительно сообщений об ошибках, пожалуйста проконсультируйтесь с amine48rz, Caemyr или gabriel_it на irc-канале:

* Старайтесь не вставлять отладочные данные непосредственно в сообщение об ошибке, лучше прикрепите его к сообщению. Это способствует удобочитаемости сообщения.

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

* Сообщение об ошибке должно описывать одну-единственную проблему или случай, даже если эта ошибка проявляется в нескольких приложениях или имеет множество способов воспроизведения.

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

* Не описывайте более одной проблемы в одном сообщении об ошибке. Единственным исключением является то, что они связаны с одним и тем же приложением или системным компонентом, и только если вы перед отправкой сообщения проконсультировались с amine48rz или Caemyr.

* Ошибки, описание которых не соответствует приведенным рекомендациям, будут закрыты как "НЕДОПУСТИМЫЕ'", и пользователя, написавшего отчет, попросят сообщить об ошибке должным образом.

=== Использование Bugzilla ===

Для использования [http://reactos.org/bugzilla Bugzilla], вам необходимо [http://www.reactos.org/roscms/index.php/зарегистрироваться/ создать] учётную запись на сайте ReactOS.org, с которой вы получите доступ к Bugzilla.

Хотя форма отчета об ошибке Bugzilla крайне проста, здесь приведены несколько советов:

* '"Version'": Если вы используете официальный релиз, пожалуйста, укажите версию ReactOS, которую Вы используете. Если Вы используете сборку из SVN, которая новее чем последний официальный выпуск, то пожалуйста, используйте версию "ТРАНК".

* '''Component''': Это "место" ReactOS, где находится ошибка. Ссылка на [http://www.reactos.com/bugzilla/describecomponents.cgi?product=ReactOS компонент] находящаяся рядом с блоком выбора этого компонента, поясняет назначение каждого компонента. Если вы не уверены, то попытайтесь предположить, а мы впоследствии можем это изменить.

* '''Platform''': Пожалуйста, укажите, на какой аппаратной платформе произошла ошибка. Если вы не уверены, то используйте значение по умолчанию "x86 Hardware"

* '"OS'": Операционная система, на которой произошла ошибка. Обычно это будет "ReactOS", но, если вы проверяли компоненты ReactOS на Windows, пожалуйста укажите её версию.

* '''Severity''': Указывает "степень" серьезности ошибка. Для большинства ошибок, этот параметр необходимо оставить в состоянии "normal", мы сами скорректируем ее при необходимости. Пожалуйста, не регистрируйте ошибки как "blocker". Координатор группы тестирования или разработчики сами определят, является ли ошибка блокирующей. Пожалуйста см. [http://www.reactos.org/bugzilla/page.cgi?id=fields.html#bug_severity Степени серьёзности в ReactOS Bugzilla] для получения дополнительной информации.

* '''Assigned To''': Это поле будет заполнено автоматически, когда Вы выберете ''Component''.

* '"URL'": Если эта ошибка произошла в компоненте "Онлайн-службы", пожалуйста, укажите URL страницы, на которой возникли проблемы.

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

* '''Description''': Детальное описание ошибки. Пожалуйста, укажите всю собранную вами информацию (выше).

* '''Depends On''': Ошибки, которые необходимо устранить перед тем, как устранять описываемую ошибку. Мы заполним это поле при необходимости.

* '''Blocks''': Требуется устранить описываемую ошибку, чтобы исправить перечисленные в этом поле. Мы заполним его при необходимости.

* '''Add an Attachment''': Эта кнопка может использоваться для прикрепления файлов (протоколов отладки, скриншотов, исправлений) к сообщению об ошибке.

=== Как не нужно создавать сообщение об ошибке. Случаи из реальной жизни (ничего личного) ===

{{bug|4721}} При попытке запуска Microsoft Word Viewer 2003, он выдаёт мне ошибку, а затем исчезает панель задач.

Суть проблемы:

* Заголовок сообщения слишком длинный и потерян, нам нужен короткий заголовок, описывающий проблему: "Сбои при запуске Word Viewer 2003" (Я не смог воспроизвести сбой проводника, возможно это случайная проблема).

* Отсутствует [[Отладка|протокол отладки]].

* Автор сообщения не произвёл поиск в Bugzilla по ключевым словам Word Viewer, иначе он обязательно бы наткнулся на {bug|4587}.

* Он указал ТРАНК, но будет намного лучше указать конкретный номер ревизии. У нас нет излишка свободного времени для того, чтобы просмотреть все собранные в этот день ревизии, их может быть более десяти, а что, если он пользовался ревизией, собранной в другой день? Чем больше данных вы предоставите, тем лучше.

* Ссылка на Word viewer может сэкономить время пользователю, который захочет протестировать/подтвердить наличие проблемы.

=== Некоторые сведения о Bugzilla ===

* После того, как сообщение об ошибке было опубликовано либо обновлено, отсылается email в [http://www.reactos.org/mailman/listinfo/ros-bugs список рассылки ros-bugs]

* В тексте описания производится автоматический поиск слов "attachment" ("вложение") и "bug" ("ошибка"), и в случае их обнаружения, они преобразуются в ссылку. Таким образом, если вы напишете "This may be related to bug 1234" ("Возможно, это связано с ошибкой 1234"), "bug 1234" ("ошибка 1234"), то в текст сообщения автоматически добавится ссылка на ошибку 1234. А, например, в текст "bug 1234 comment 2" ("ошибка 1234 комментарий 2") будет вставлена ссылка на ошибку 1234 и производиться переход на комментарий 2.

* Ранее, вы могли внести изменения в описание не той ошибки, которую хотели изменить из-за наличия "особенности" в работе Bugzilla. После изменения описания ошибки, Bugzilla открывает описание следующей ошибке в вашем списке, так что, если бы вы хотели добавить что-либо ещё в своем предыдущем комментарии, то Вы обновили бы другую ошибку. Пожалуйста, установите параметр настройки Bugzilla: General preferences -> "After changing a bug" (Общие настройки-> "Действия после изменения описания ошибки") в состояние "показать обновленное описание ошибки" и нажмите кнопку подтверждения изменений.

* Для получения дополнительной информации об использовании Deskzilla с ReactOS Bugzilla, пожалуйста, прочтите страницу [[Deskzilla]].

[[Категория:Тестирование]]