diff options
Diffstat (limited to 'files/ru/qa/руководящие_принципы_написания_ошибка/index.html')
| -rw-r--r-- | files/ru/qa/руководящие_принципы_написания_ошибка/index.html | 230 |
1 files changed, 230 insertions, 0 deletions
diff --git a/files/ru/qa/руководящие_принципы_написания_ошибка/index.html b/files/ru/qa/руководящие_принципы_написания_ошибка/index.html new file mode 100644 index 0000000000..9f5d04bc1d --- /dev/null +++ b/files/ru/qa/руководящие_принципы_написания_ошибка/index.html @@ -0,0 +1,230 @@ +--- +title: Руководство по описанию ошибок +slug: QA/Руководящие_принципы_написания_ошибка +tags: + - Инструкция + - баг + - багрепорт + - отчет об ошибках + - тестирование +translation_of: Mozilla/QA/Bug_writing_guidelines +--- +<div class="note"> +<p><strong>Если вам нужна помощь с программой от Mozilla (наример, Firefox, Seamonkey или Thunderbird), используйте <a href="http://www.mozilla.org/support/">сайты поддержки</a>.</strong> Не редактируйте эту страницу!</p> +</div> + +<p>В этом разделе предполагается, что вы хотите внести свой вклад в проект Mozilla путем сбора достаточного количества информации для написания полезных отчетов об ошибках в Bugzilla, системе отслеживания ошибок от Mozilla. Спасибо!</p> + +<p>Если вы новичок в написании багов, вы можете попытаться получить помощь от более опытных участников. С мотрите раздел Сообщества на странице <a href="/en-US/docs/QA">QA</a> для ccылок. Если вы собираетесь создать багрепорт для Firefox, вы можете получить помощь на сайте <a href="irc://irc.mozilla.org/firefox">irc.mozilla.org</a> в канале <span style="font-family: monospace;">#firefox</span> . Для других приложений вроде Thunderbird, Seamonkey, … вы можете попытаться найти подходящий канал в <a href="https://wiki.mozilla.org/IRC">IRC</a>.</p> + +<h2 id="Как_сообщить_об_ошибке">Как сообщить об ошибке</h2> + +<h3 id="Открывайте_новый_баг_для_каждой_проблемы!">Открывайте новый баг для каждой проблемы!</h3> + +<p>Только так будет возможен эффективный процесс исправления ошибок.</p> + +<h3 id="Другие_детали_которые_следует_учитывать">Другие детали, которые следует учитывать</h3> + +<ol> + <li>Выясните шаги воспроизведения бага: + <ul> + <li>Если у вас есть точные шаги воспроизведения - отлично! - вы на пути к созданию полезного сообщения об ошибке;</li> + <li>Если вы можете воспроизвести баг время от времени, но не после следования конкретным шагам, вы должны предоставить дополнительную информацию о баге, чтобы он был полезен;</li> + <li>Если вы не можете воспроизвести проблему, вероятно нет смысла сообщать о ней, пока вы не предоставите уникальную информацию об ее возникновении;</li> + </ul> + </li> + <li>Убедитесь, что программное обеспечение в актуальном состоянии. В идеале, тестируйте версию в процессе разработки, чтобы видеть был ли ваш баг уже исправлен (например <a href="http://www.mozilla.com/en-US/firefox/channel/">Firefox Beta, Aurora</a>, или передовой <a class="link-https" href="https://nightly.mozilla.org/">Nightly</a>).</li> + <li>Если вы создаете багрепорт для Firefox, убедитесь сначала что вы можете воспроизвести баг <a href="https://support.mozilla.org/en-US/kb/profile-manager-create-and-remove-firefox-profiles">в новом профиле Firefox</a>. Если баг воспроизводится только в вашем профиле, попытайтесь вычислить какие именно <a href="https://support.mozilla.org/en-US/kb/troubleshoot-extensions-themes-to-fix-problems">настройки, расширения</a>, or <a href="http://support.mozilla.com/en-US/kb/Profiles">файлы в вашем профиле</a> необходимы для воспроизведения бага. + <ul> + <li>Если баг выглядит серьезно (т.е. очевидно что он затронет значительнцю часть пользователей), имеется нечто действительно необычное относительно конфигурации вашего приложения и это нечто является важным шагом к воспроизведению проблемы. Вы имеете намного больше шансов выяснить что именно вызывает проблему, чем разработчик который не имеет доступа к вашей системе.</li> + <li>Если баг попадает в одну из <a href="#specific-types">специальных категорий багов перечисленных в секции ниже</a>, его регистрация все равно может быть полезной даже если вы не можете воспроизвести его в новом профиле Firefox.</li> + </ul> + </li> + <li>Откройте форму <a class="link-https" href="https://bugzilla.mozilla.org/enter_bug.cgi?format=guided">Регистрации нового бага</a>, и следуйте дальнейшим подсказкам которые проведут вас через все шаги процесса регистрации бага: + <ul> + <li>Создайте аккаунт Bugzilla если у вас его еще нет, выберете продукт в котором была найдена ошибка;</li> + <li>Введите <strong>понятное и уникальное название</strong> как <a href="#clear-summary">показано ниже</a>; проверьте что до вас никто этот баг еще не регистрировал (если вы хотите проверить это тщательно, ознакомьтесь с инструкцией по <a href="/en-US/docs/Screening_duplicate_bugs">Предотвращению дублирования багов</a>.)</li> + <li>Опишите <strong>точные шаги по воспроизведению бага</strong>, <strong>ожидаемый </strong> и <strong>фактический результаты</strong> как <a href="#str">описано в следующей секции</a>;</li> + <li>Опишите дополнительную информацию (как <a href="#additional-info">показано ниже</a>), особенно если вы не можете воспроизвести баг в новом профиле и/или создаете отчет о <strong>аварийном завершении</strong>, <strong>использовании памяти</strong>, <strong>производительности</strong>, <strong>регрессе</strong> или если проблема проявляется только на определенном веб сайте.</li> + </ul> + </li> + <li>Если вы собираетесь зарегистрировать нескольк ошибок, пожалуйста зарегистрируйте каждую ошибку в виде отдельного бага.</li> +</ol> + +<div class="boxed translate-rendered"> +<h2 id="Написание_понятного_названия"><a name="clear-summary">Написание понятного названия</a></h2> + +<p>Как бы вы описали баг используя для этого всего 10 слов? Какой бы способ вы ни выбрали, помните: название - это самая первая часть вашего багрепорта которую увидит разработчик.</p> + +<p>Хорошее название должно быстро и уникально идентифицировать багрепорт. Оно должно описывать проблему, а не предлагаемое решение.</p> + +<ul> + <li>Хорошо: "Отмена копирования файлов приводит File Manager к падению"</li> + <li>Плохо: "Приложение падает"</li> +</ul> + +<ul> + <li>Хорошо: "Стрелка вниз в скроллинге не работает в <textarea> с overflow:hidden"</li> + <li>Плохо: "Браузер должен работать с моим сайтом"</li> +</ul> + +<h2 id="Написание_точных_шагов_воспроизведения_бага"><a name="str">Написание точных шагов воспроизведения бага</a></h2> + +<p>Как разработчик сможет воспроизвести баг на своем собственном компьютере?</p> + +<p>Шаги для воспроизведения проблемы являются <strong>самой главной частью вашего багрепорта</strong>. Если разработчик в состоянии воспроизвести баг, шанс что он будет исправлен наиболее высок. Если шаги недостаточно точны, то в самом деле: даже выяснить был ли баг на самом деле исправлен будет нельзя.</p> + +<table class="standard-table"> + <tbody> + <tr> + <th>Что хороший багрепорт должен содержать?</th> + <th>Хороший (понятный) пример</th> + <th>Плохой (непонятный)</th> + </tr> + <tr> + <td>Содержит точное указание что вы можете воспроизвести этот баг всегда, иногда или не можете воспроизвести его вовсе</td> + <td>Я могу воспроизвести этот баг следуя этим шагам:</td> + <td> </td> + </tr> + <tr> + <td> + <p>Опишите свой метод взаимодействия с Firefox вместе с тем чего вы намеревались добиться совершая каждый шаг.</p> + </td> + <td> + <p>1. Запускаю Firefox кликая на значок рабочего стола<br> + 2. Нажимаю Cmd+N для того чтобы открыть новое окно браузера<br> + 3. Вставляю <a class="link-https" href="https://mail.google.com/" rel="freelink">https://mail.google.com/</a> в строку адреса и нажимаю Enter</p> + </td> + <td>Открываю Gmail в другом окне</td> + </tr> + <tr> + <td> + <p>После выполнения ваших шагов, точно опишите <strong>наблюдаемый (фактический) результат</strong> и <strong>ожидаемый результат</strong>. Точно отделяйте факты (наблюдения) от умозаключений.</p> + </td> + <td><strong>Ожидаемые результаты</strong>: Папка входящих писем показывается корректно.<br> + <strong>Фактический результат</strong>: В папке входящих писем отображается надпись 'Ваш браузер не поддерживает куки (ошибка -91)'.</td> + <td> + <p>"Не работает"</p> + + <p>"Страница отображается некорректно"</p> + </td> + </tr> + </tbody> +</table> + +<h2 id="Описание_дополнительной_информации"><a name="additional-info">Описание дополнительной информации</a></h2> + +<p>Следующая информация запрашивается разработчиками практически для любого бага. Вы значительно сохраните время если сразу предоставите ее после описания ожидаемого результата. Если вы хотите прикрепить один или несколько файлов, вы можете сделать это сразу после создания багрепорта.</p> + +<h3 id="Для_специальных_видов_багов"><a name="specific-types">Для специальных видов багов</a></h3> + +<p>Если вы создаете багрепорт об <strong>аварийном завершении</strong>, пожалуйста <a href="https://developer.mozilla.org/en-US/docs/How_to_get_a_stacktrace_for_a_bug_report">приложите к багу Breakpad ID или стектрейс ошибки</a>, а также укажите сигнатуру аварийного завершения (crash signature) в названии бага помимо указания сигнатуры аварийного завершения в поле <strong>Crash Signature</strong>.</p> + +<p>Если вы создаете багрепорт об <strong>использовании оперативной памяти или об утечке памяти</strong>, пожалуйста <a href="https://developer.mozilla.org/en-US/docs/Mozilla/Performance/about:memory">приложите текст страницы about:memory</a>. Было бы замечательно, найдите шаги приводящие к увеличению памяти отображаемой в about:memory (наблюдаемое даже после нажатия кнопки "Минимизировать расход памяти" ("Minimize memory usage")). Если вы не можете вычисли шаги для воспроизведения, попробуйте изучить страницу поддержки Firefox, которая называется <a href="http://support.mozilla.com/en-US/kb/High%20memory%20usage">Высокий расход памяти</a>. Если вы являетесь разработчиком C++, то вам доступны <a class="link-https" href="https://developer.mozilla.org/en-US/docs/Mozilla/Performance">более точные инструменты</a>.</p> + +<p>Если вы создаете багрепорт о <strong>низкой производительности или высокой загрузке ЦПУ</strong>, пожалуйста <a href="https://developer.mozilla.org/en-US/docs/Mozilla/Performance/Reporting_a_Performance_Problem">предоставьте ссылку на профиль производительности</a>.</p> + +<p>Если вы создаете багрепорт об <strong>ошибке связанной с конкретной веб страницей</strong>, пожалуйста попытайтесь создать <a href="https://developer.mozilla.org/en-US/docs/Reducing_testcases">небольшай тестовый пример</a> и прикрепите его к багрепорту. Если у вас нет времени или достаточных знаний, пожалуйста сообщите об ошибке по адресу <a href="https://webcompat.com/">webcompat.com</a>, где наши добровольцы помогут вам.</p> + +<p>Если вы создаете багрепорт об ошибке связанной с <strong>зависанием Flash</strong>, пожалуйста посетите <a href="https://wiki.mozilla.org/Flash/Hang_Debugging">https://wiki.mozilla.org/Flash/Hang_Debugging</a> для того чтобы изучить как собрать полезную для разработчиков информацию.</p> + +<p>Если баг <strong>появился недавно</strong>, использование специального <a href="http://quality.mozilla.org/docs/bugzilla/guide-to-triaging-bugs-for-firefox/finding-a-regression-window/">окна регресса</a> может помочь определить причину ошибки.</p> + +<p><a href="http://www.chiark.greenend.org.uk/%7Esgtatham/bugs.html#intermittent">Что если мой баг выглядит "случайным" или "появляющимся время от времени"?</a></p> + +<h3 id="Большинство_ошибок_Firefox">Большинство ошибок Firefox</h3> + +<p>Вы должны предоставлять нижеследующую информация для большинства багов Firefox.</p> + +<table class="standard-table"> + <tbody> + <tr> + <th>Что следует включать в багрепорт?</th> + <th>Пример</th> + </tr> + <tr> + <td>Сообщите можете ли вы воспроизвести проблему в <a href="https://support.mozilla.org/en-US/kb/profile-manager-create-and-remove-firefox-profiles">новом профиле Firefox</a> и любые изменения которые нужно сделать в профиле для того что проблема появилась.</td> + <td>Проблема воспроизводится в новом профиле, но только если включена настройка Настройки -> Безопасность -> Сообщать сайтам что я не хочу чтобы меня отслеживали.</td> + </tr> + <tr> + <td>Если ошибку получается воспроизвести только в вашем существующем профиле попытайтесь определить <a href="https://support.mozilla.org/en-US/kb/troubleshoot-extensions-themes-to-fix-problems">настройки, расширения</a>, или <a href="http://support.mozilla.com/en-US/kb/Profiles">файлы в вашем профиле</a> необходимые для воспроизведения бага. Если вы не можете этого сделать и хотите пропустить этот шаг, пожалуйста <a href="https://support.mozilla.org/en-US/kb/use-troubleshooting-information-page-fix-firefox">сохраните информацию со страницы about:support</a> в файл и прикрепите к багрепорту.</td> + <td>Баг не воспроизводится в новом профиле, информация с about:support для проблемного профиля прикреплена.</td> + </tr> + <tr> + <td> + <p>Сообщите если проблема воспроизводится в <a href="https://nightly.mozilla.org/">последней ночной сборке</a>. Включите <strong>Идентификатор сборки (Build ID)</strong> со страницы <a href="https://support.mozilla.org/en-US/kb/use-troubleshooting-information-page-fix-firefox">about:support</a>.</p> + + <p>Если возможно, протестируйте используя новый профиль Firefox. Если требуется протестировать ночную сборку с проблемным профилем, рекомендуется сначала сделать <a href="https://support.mozilla.org/en-US/kb/back-and-restore-information-firefox-profiles">резервную копию профиля</a>, так как ночная сборка может разрушить целостность данных профиля.</p> + </td> + <td>Проблема воспроизводится в последней ночной сборке (Build ID 20150331030204).</td> + </tr> + </tbody> +</table> + +<p> </p> + +<div class="originaldocinfo"> +<h2 id="Информация_об_исходном_документе">Информация об исходном документе:</h2> + +<ul> + <li>Автор(ы): Jesse Ruderman, Gervase Markham</li> + <li>Другие контрибьюторы: Eli Goldberg, Claudius Gayle, Jan Leger, Felix Miata, Peter Mock, Chris Pratt, Chris Yeh, and others.</li> +</ul> +</div> + +<p> </p> + +<hr> +<h2 id="Продвинутые_темы">Продвинутые темы</h2> + +<h3 id="Finding_the_correct_product_and_component" name="Finding_the_correct_product_and_component"><strong style="font-weight: bold;">Поиск правильного продукта и компонента</strong></h3> + +<p>Для каждого бага вам нужно выбирать правильный "продукт" и "компонент" в этом продукте, для того чтобы ваш багрепорт получил разработчик которому он предназначен.</p> + +<p>Если вы используете Firefox, баг находится скорее всего в компонетах "Firefox", "Toolkit", или "Core".</p> + +<ul> + <li><a class="link-https" href="https://bugzilla.mozilla.org/describecomponents.cgi?product=Firefox">Список компонентов продукта "Firefox"</a> - большинство компонентов Firefox с которыми вы непосредственно взаимодействуете</li> + <li><a class="link-https" href="https://bugzilla.mozilla.org/describecomponents.cgi?product=Toolkit">Список компонентов продукта "Toolkit"</a> - виджеты интерфейса и некоторые другие функции интерфейса</li> + <li><a class="link-https" href="https://bugzilla.mozilla.org/describecomponents.cgi?product=Core">Список компонентов продукта "Core"</a> - отрисовка веб станиц, сетевые функции и др.</li> +</ul> + +<p>Если сомневаетесь, найдите похожие баги и посмотрите к каким они отнесены компонентам.</p> + +<p>Если ни один компонент не выглядит подходящим, взгляните на компонент "General" который есть у большинства продуктов.</p> + +<h3 id="Общая_структура_багрепорта">Общая структура багрепорта</h3> + +<div class="note"> +<p>Эта статья была перенесена сюда из <a href="https://wiki.mozilla.org/QA/QMO">QMO</a>: <a class="link-https" href="https://quality.mozilla.org/docs/bugzilla/starter-kit/how-to-write-a-proper-bug/">Как писать понятные багрепорты</a></p> +</div> + +<ul> + <li><strong>Название</strong>: Как бы вы описали ошибку используя не более 60 символов? Название должно кратко и однозначно давать представление в чем проблема, а не описывать предложенное вами решение. Хорошо: "Отмена диалога копирования фалов приводит к падению файлового менеджера" Плохо: "Программа падает" Плохо: "Браузер должен работать с моим сайтом"</li> + <li><strong>Компонент</strong>: В какой части приложения происходит ошибка? Это поле является обязательным для всех багрепортов. Кликните по слову "Component" чтобы увидеть описание каждого компонента. Если нет ничего подходящего, выбирайте компонент "General".</li> + <li><strong>ОС</strong>: В какой операционной системе (ОС) вы обнаружили эту проблему? (т.е. Linux, Windows XP, Mac OS X.) Пример: "<em>Если вы уверены что этот баг проявляется больше чем на одной ОС выбирайте All. Если вашей ОС нет в списке выбирайте Other".</em></li> + <li><strong>Описание</strong>: Подробности проблемы включающие: + <ul> + <li><u>Обзор</u>: это более подробно переформулированное название бага. Например: <em>"Перетаскивание любой страницы приводит к падению сборок для Mac в функции NSGetFactory"</em>.</li> + <li><u>Идентификатор сборки (Build Id)</u>: Чтобы найти идентификатор либо откройте страницу "about:support" через строку адреса или, если у вас есть расширение <a href="https://addons.mozilla.org/en-US/firefox/addon/nightly-tester-tools/">Nightly Tester Tools</a> от MozQA, тогда проследуйте в Инструменты | Nightly Tester Tools и найдите опцию которая содержит идентификатор сборки. Выглядит примерно так: <em>"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10; rv:38.0) Gecko/20100101 Firefox/38.0 ID:20150330004006 CSet: 9e57e9776571"</em>.</li> + <li><u>Дополнительные сборки и платформы</u>: воспроизводится ли баг на других платформах (или браузерах, если это имеет смысл). Должно выглядеть как то так: <em>"Не происходит на Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10; rv:38.0) Gecko/20100101 Firefox/38.0 ID:20150330004006 CSet: 9e57e9776571"</em>.</li> + </ul> + </li> + <li><strong>Шаги для воспроизведения</strong>: Минимально-необходимое и простое описание шагов которые приводят к появлению бага. Если необходимо, включите необходимые шаги настройки приложения. Хороший пример:<br> + 1) Взгляните на веб страницу. (Я использовал http://www.google.com/).<br> + 2) Выделите текст при помощи перетаскивания. Конкретно, удерживая клавишу мыши, тащите указатель мыши вниз из любой точки содержимого веб страницы к самому низу страницы.</li> + <li><strong>Фактические результаты</strong>: Что происходит после выполнения шагов. Пример: <em>Приложение падает.</em></li> + <li><strong>Ожидаемый результат</strong>: Что приложение должно сделать. Пример: <em>Окно должно скроллироваться вниз. Промотанное содержимое должно выделяться. Как минимум, приложение не должно падать!</em></li> +</ul> + +<p>Дальшейшее чтение <a href="http://quality.mozilla.org/docs/bugzilla/starter-kit/how-to-write-a-proper-bug-part-2/">Как написать понятный баг репорт Часть 2</a></p> + +<div class="originaldocinfo"> +<h4 id="Информация_об_исходном_документе_2">Информация об исходном документе</h4> + +<ul> + <li>Автор(ы): Aakash Desai</li> + <li>Дата последнего изменения: June 3, 2013 at 2:41 am PST</li> +</ul> +</div> +</div> |