Как сообщить об ошибке

сокращение: BUGREPORT
From mediawiki.org
This page is a translated version of the page How to report a bug and the translation is 99% complete.


Фабрикатор предназначен для сообщений о багах в ПО, для запросов новых функций и для планирования работы.
  • Чтобы задать вопросы технического характера о проектах Викимедиа, обратитесь на Техфорум
  • Чтобы задать вопросы технического характера о MediaWiki, используемый не в проектах Викимедиа, обратитесь в Центр помощи

Эти инструкции объясняют, как написать хорошее сообщение об ошибке или запросить новую функцию в трекере задач Wikimedia (подробнее см. Фабрикатор ). Хорошо написанные задачи с большей вероятностью будут отработаны. Задачи следует писать на английском языке. Если вы не знаете английского языка, попробуйте использовать инструменты машинного перевода, например Google Translate.

Краткие рекомендации

  • Будьте точны
  • Выражайтесь ясно: 1) объясните, как пошагово воспроизвести проблему, не оставляя возможности для разночтений, 2) ожидаемое поведение, 3) фактическое поведение. Всё в отдельных разделах
  • Включайте только один конкретный баг или один конкретный запрос функции в ваше задание
  • Включайте любые подходящие ссылки и примеры

Перед тем, как вы сделаете что-либо

Можете ли вы воспроизвести проблему?

Попробуйте воспроизвести свою проблему на последней версии программного обеспечения, чтобы убедиться, что она до сих пор не устранена. Если ошибка присутствует на вики-сайте, например, на Википедии, вы можете попробовать последнюю версию ПО на test2.wikipedia.org.

Кто-нибудь ещё сообщал об этой ошибке?

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

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

Может быть, проблема в пользовательском скрипте или гаджете?

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

Это проблема с кешированием?

Some issues relate to older cached HTML being served alongside newer JavaScript where the two are incompatible. To help determine if this is the cause it is helpful to purge the page, refresh the page and see if the issue persists and include this information in your bug report.

Сообщение об ошибке или запрос функции

Если вы встретились с ошибкой в новой версии и ещё никто не сообщал о ней, то:

  1. Перейдите на phabricator.wikimedia.org.
  2. Вам нужно будет авторизоваться (или зарегистрироваться), если вы ещё не сделали этого (смотрите раздел «Создание учётной записи »).
  3. Нажмите кнопку Закладка в правом верхнем углу и выберите «Создать задачу» (или «Сообщить о проблемах безопасности», чтобы сообщить о проблеме безопасности ).
  4. Заполните следующие поля:
    • Title (краткое описание): короткое резюме, которое объясняет проблему (а не решение, предлагаемое вами).
      • Хорошо: "Selecting gender is not functional on Special:Preferences"
      • Плохо: "Software crashes"
    • Description (описание): полное описание проблемы, включающее столько подробностей, сколько возможно. Если этого недостаточно, вас попросят получить дополнительную информацию вместе с руководством о том, как ее получить. Это поле должно включать:
      • Для ошибок:
        • Steps to Reproduce (шаги для воспроизведения проблемы): Краткая последовательность несложных для следования шагов, которая вызовет описываемую проблему. Включайте специальные шаги по настройке.
          Пример:
          1. Go to https://en.wikipedia.org with Internet Explorer version 10.0;
          2. Make sure you are logged in;
          3. Select "My Preferences" menu;
          4. Go to "Gender" and select female gender from box list;
          5. Click "Save" button.
        • Actual Results (фактические результаты): Реакция приложения на вышеприведённую последовательность действий.
          Пример:
          "There is no female gender in front of my username."
        • Expected Results (ожидаемые результаты): Что ожидается от приложения, если бы ошибки не было.
          Пример:
          "My gender is shown in front of my username."
      • Для запросов функционала:
        • Описание того, что вы хотите получить и почему. Объясните, что, как вы надеетесь, эта функция решит (реальную проблему), а также конкретные примеры; но не требуйте конкретного решения, так как могут быть другие/лучшие решения. Пользовательская история - эффективный способ передать это.
          Пример:
          "As a new editor, I would like to be acknowledged for my contribution to the project, so that I feel welcomed and valued"
      • Пожалуйста, предоставьте также любую дополнительную информацию, которая могла бы быть полезна, такую как:
        • веб-браузер, стиль оформления или ОС, в которой вы видите ошибку;
        • ссылки на страницы или сравнение версий, в которых вы столкнулись с ошибкой; или
        • возникает ли проблема постоянно, или же время от времени, только на некоторых страницах, или в каких-то специфических условиях.
    • Чтобы приложить к отчёту файл журнала или снимок экрана (предварительно убедившись, что конфиденциальные данные во вложении или скриншоте отсутствуют), нажмите кнопку Upload File (облако со стрелкой) в панели инструментов для поля Description.
    • Выберите tags (проект(ы)), где была найдена ошибка:
      • Проекты — это способ, с помощью которого разработчики находят задачи, над которыми можно работать. Чтобы идентифицировать нужные вам проекты, используйте функцию поиска (справа вверху), чтобы найти описание.
      • Это может быть, например, MediaWiki-General-or-Unknown для самого ПО вики или Wikimedia-Site-Requests, если нужно настроить один из вики-сайтов (смотрите Selecting projects ).
    • Subscribers (подписавшиеся): если вы знаете пользователей, которые заинтересуются данной проблемой, можете добавить их в это поле. Иначе, проигнорируйте это поле.

Убедитесь, что ваш отчёт закончен, затем нажмите кнопку «Create Task» (создать задачу). Ваш отчёт будет помещён в базу данных. Это позволяет кому-либо, заинтересованному в отчёте, просмотреть его и потенциально поработать с ним .

Приоритет для задания будет установлен разработчиками, которые планируют работу над проблемой (см. «Задание приоритетов»).

Готово! Спасибо за то, что помогаете улучшать MediaWiki и проекты Викимедиа!

Сообщить об ошибке в JavaScript

См. также: Help:Locating broken scripts

Многие функции сайта, например гаджеты и пользовательские скрипты, а также некоторые компоненты MediaWiki, используют JavaScript.

Когда вы обнаруживаете ошибку, которая может быть связана с JavaScript, сделайте всё возможное, чтобы идентифицировать сообщения об ошибках и скопировать их в отчёт об ошибке.

Особенно важно предоставить всю имеющуюся у вас информацию, потому что даже системные администраторы не будут иметь доступа ни к каким журналам ошибок.

Если проблема вызвана ошибкой в коде самого пользовательского сценария или гаджета, Phabricator вряд ли окажется площадкой, где проблема будет разобрана.[1] Вас могут направить на страницу обсуждения сценария (если вызывающий проблему сценарий будет идентифицирован).

Сообщение об ошибке связи

Если у вас возникли сложности с доступом к сайту Викимедиа (медленное интернет-соединение и т.п.), пожалуйста, перейдите на страницу с инструкциями о том, как сообщить об ошибке связи.

Сообщение о проблеме со входом в учётную запись

Если вы не можете войти в свою учётную запись, обратитесь к инструкции на странице Manual:How to debug/Login problems.

Примечания

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