Як повідомити про помилку
- Щоб поставити технічні запитання про проєкти Вікімедіа, див. сторінку m:Tech
- Щоб поставити технічні запитання щодо MediaWiki поза використанням ФВМ, див. Project:Support desk
Ці настанови пояснюють, як написати хороший звіт про помилку чи запит на нову функцію (завдання) на баґтрекері Вікімедіа (див. детальніше Фабрикатор ). Якісно написані звіти сприяють вирішенню проблеми. Звіти про помилки потрібно писати англійською мовою. Якщо ви не володієте англійською, скористайтеся інструментом машинного перекладу на зразок Google Translate.
Короткі рекомендації
- Будьте точними
- Висловлюйтесь ясно: поясніть, 1) як відтворити проблему, крок за кроком, точно описаними діями; 2) очікувану поведінку рушія; 3) фактичну його поведінку. В окремих розділах
- Кожна задача має містити опис лише одної проблеми чи запит одної функції
- Додайте всі відповідні посилання й приклади
Перед тим, як щось зробити
Чи можете ви відтворити проблему?
Спробуйте відтворити знайдену помилку на останній версії програмного забезпечення, щоб побачити, чи її ще не виправили. Якщо помилка присутня на вікісайті, наприклад, Вікіпедії, то свіжу версію програмного забезпечення Ви можете протестувати на test2.wikipedia.org.
Чи хтось інший вже повідомляв про цю проблему?
Скористайтеся полем пошуку на баґ-трекері Вікімедіа, щоб впевнитися, що про Вашу проблему ще немає звіту, або запитану функцію. Також Ви можете виконати розширений пошук на сторінці розширеного пошуку.
Якщо ви не впевенені, чи про помилку уже повідомили, вам варто все одно про нього написати. Краще мати повідомлення-дублікати, ніж помилки, про які не було звітів.
Може це проблема з додатком чи користувацьким скриптом?
Деякі проблеми є наслідком використання користувацьких скриптів та додатків, які потребують виправлень. Є посібник із розписаними кроками для визначення того коду, який може виправили вашу проблему, щоб вам не треба було витрачати час на звіт про неї.
Is it a caching issue?
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.
Звіт про нову помилку або запит на функцію
Якщо ви зіткнулися з помилкою в останній версії і ще ніхто про неї не повідомив, то:
- Перейдіть на phabricator.wikimedia.org.
- Вас попросять увійти (або зареєструватися), якщо Ви цього не зробили (див. «Створення облікового запису »).
- Натисніть на кнопку «Закладка» у правому верхньому кутку і виберіть «Створити завдання» (або «Повідомити про проблему безпеки», щоб повідомити про проблему безпеки ).
- Заповніть хоча б наступні поля:
- Title (заголовок): Короткий опис, що характеризує проблему одним реченням (а не вирішення, яке Ви пропонуєте).
- Добре:
"Selecting gender is not functional on Special:Preferences"
- Погано:
"Software crashes"
- Добре:
- Description (опис): Повний опис проблеми, що містить всі подробиці, наразі вам відомі. If that is insufficient you will be asked for additional information along with guidance on how to obtain it. Це поле має включати:
- Для помилок:
- Steps to Reproduce (кроки відтворення): Коротка послідовність кроків, що призводить до появи описуваної проблеми. Включаючи всі налаштування.
- Приклад:
Go to https://en.wikipedia.org with Internet Explorer version 10.0;
Make sure you are logged in;
Select "My Preferences" menu;
Go to "Gender" and select female gender from box list;
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."
- Приклад:
- Steps to Reproduce (кроки відтворення): Коротка послідовність кроків, що призводить до появи описуваної проблеми. Включаючи всі налаштування.
- Для зручності запитів:
- Опис того, що Ви хочете отримати і чому. Поясність, що, на вашу думку, функція має вирішити (власне, вихідну проблему), додавши конкретні приклади; але не вимагайте конкретного рішення, бо ж можуть існувати інші/кращі рішення. Розповідь користувача — ефективний спосіб це передати.
- Приклад:
"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.
- Оберіть теги (проєкти), у яких Ви знайшли помилку:
- Проєкти — це спосіб, у який розробники знаходять завдання для роботи. Щоб визначити правильні проєкти, скористайтеся функцією пошуку (угорі справа), щоб знайти їх описи.
- Це може бути, наприклад, проєкт
MediaWiki-General
для самого програмного забезпечення вікі абоWikimedia-Site-Requests
для зміни конфігурації на веб-сайті Вікімедіа (див. Selecting projects ).
- Підписані (поставити на копію): Якщо Ви знаєте конкретних користувачів, які зацікавляться цим питанням, можете додати їх тут. В іншому разі, проігноруйте це поле.
- Title (заголовок): Короткий опис, що характеризує проблему одним реченням (а не вирішення, яке Ви пропонуєте).
Перевірте, що Ваш звіт завершений, тоді натисніть кнопку «Створити завдання» (Створити завдання). Ваш звіт тепер буде у базі даних. Завдяки цьому зацікавлена у відгуку людина зможе на нього подивитися і потенційно взяти в роботу .
Пріоритет для завдання встановлять розробники, якщо вони збираються працювати над завданням (див. Вказання пріоритетів).
Готово! Дякуємо за вашу допомогу у покращенні MediaWiki та проєктів Вікімедіа!
Повідомлення про помилку JavaScript bug
- Див. також: Довідка:Виявлення поламаних скриптів
Чимало функціоналу, такого як додатки, користувацькі скрипти та деякі частини MediaWiki, використовують JavaScript.
Якщо Ви зіткнулися з проблемою, що може бути пов'язана з JavaScript, зробіть усе можливе, щоб знайти повідомлення помилки і скопіювати їх у звіт про помилку.
Дуже важливо надати усю інформацію, яку Ви маєте, бо навіть системні адміністратори не матимуть ніякого доступу до жодного журналу помилок.
Якщо проблема у коді самого користувацького скрипта чи додатка, тоді, можливо, Фабрикатор — не те місце, де проблема вирішиться.[1] Хтось може перенаправити вас на сторінку обговорення скрипта (якщо визначено конкретний скрипт, який породжує проблему).
Повідомлення про проблему зв'язку
Якщо у вас є проблеми з узагалі доступом до вебсайту Вікімедіа (повільне інтернет-з'єднання абощо), будь ласка, слідуйте рекомендаціям на сторінці https://wikitech-static.wikimedia.org/wiki/Reporting_a_connectivity_issue
Повідомлення про проблему входу в систему
Якщо у вас виникли проблеми з входом у свій обліковий запис, будь ласка, слідуйте цій інструкції: Manual:How to debug/Login problems .
Нотатки
Див. також
- «Як ефективно повідомляти про помилки», автор Simon Tatham
- Wikimedia Phabricator
- Менеджмент помилок/Життєвий цикл звітів про помилки
- Написання гарного звіту або запиту на функцію
- Звіти про помилки та запити на функції в англомовній Вікіпедії