Как правильно составлять баг-репорты

[Tranquillity]

​

Правильно составленный баг-репорт - это залог быстрого решения вашей проблемы.

Уважаемые владельцы серверов, если у вас сервер падает по непонятной причине по несколько раз за день, не запускается или плагины работают не корректно - не надо бежать на форум и создавать очередную тему "Помогите! Ничего не работает!" без какой либо конкретики в ней.

Уделите время на осознание своей проблемы, соберите нужные данные, подчеркните ключевые моменты возникновения проблемы и составьте правильный баг-репорт. Это ускорит решение вашей проблемы.

Общая информация.

1. Заголовок темы.​

2. Суть вашей проблемы.​

3. Возможность воспроизведения проблемы​

4. Данные о своем сервере.​

5. Наличие видео, демо файлов или скриншотов, которые отображают проблему.​

Детализация.

1. Заголовок должен быть кратким и отображать суть проблемы. Он может быть построен на схеме "Что? Где? Когда?"​

*Не работает плагин AES на ReHLDS после компиляции в ReAMX 1.8.3*​

​

2. Когда вы сообщаете об ошибке, вы это делаете потому, что хотите найти решение своей проблемы. Вы должны полностью изложить суть вашей проблемы, постарайтесь вспомнить все детали при которых она возникает (при каких условиях и как часто она проявляет себя), при этом не забывайте о грамотной и культурной речи. Опустите предположения, если хотите, но не опускайте факты.​

​

3. Если вы можете сами воспроизвести проблему, то распишите все шаги для ее воспроизведения. Распишите алгоритм ваших действий соблюдая их хронологию, чтобы разработчик смог воспроизвести проблему самостоятельно.​

​

4. Очень важно указать сразу все необходимые данные.​

​

​

Если вы не можете скомпилировать плагин:

1) Текст ошибки​

2) Тип компилятора​

3) Версия Amx Mod X​

4) Прикрепить исходник и инклуды плагина к вашему сообщению​

- Не забудьте заменить личные данные (логины и пароли), если они в нем указаны. Если вы их просто удалите, то другие подумают, что вы просто забыли их указать и в этом ошибка, поэтому просто замените их на ложные.​

Если проблема заключается в неправильной работе плагина:

1) Текст ошибок в логах или консоли сервера​

2) Операционная система​

3) Версия Amx Mod X​

4) Версия билда (узнается командой version)​

5) Наличие ReGameDLL (узнается командой game vrison)​

6) Данные команды amxx modules​

7) Данные команды amxx plugins​

8) Данные команды meta list​

9) Прикрепить исходник и инклуды плагина к вашему сообщению​

Дополнительные данные, которые так же могут помочь в решении проблемы:

• Данные команды amxx cvars (Внимание! Не копируйте в баг-репорт личные данные, которые будут отображены после ввода этой команды)
  - Можете использовать вывод кваров только нужного вам плагина. Например "amxx cvars aes" отобразит только квары плагина AES.
• Данные команды amxx cmds
  - Так же доступен вывод доступных команд по нужному плагину. Пример "amxx cmds aes".
• Добавить в plugins.ini, после названия плагина слово debug (Источник AGHL.RU)
  - Например "myplugin.amxx debug". Нужная информация будет собрана в addons\amxmodx\logs в файле, который начинается с error_
• Скриншоты или видео проблемы в игре

Если у вас падает сервер или возникают другие проблемы глобального характера:

1) Текст ошибок в логах или консоли сервера​

- Следует прописать в консоль сервера команду condebug, тогда вся информация, которая успеет попасть в консоль - будет записана в файл qconsole.log​

2) Операционная система​

3) Версия Amx Mod X​

4) Версия билда (узнается командой version)​

5) Наличие ReGameDLL (узнается командой game vrison)​

6) Данные команды meta version​

7) Данные команды amxx modules​

8) Данные команды amxx plugins​

9) Данные команды meta list​

10) Дампы падения​

- Необходимо указать в строке запуска ключ -debug. Чтобы иметь внятную информацию об ошибке в файле debug.log, вам необходимо установить в систему отладчик gdb (для ОС Centos команда будет иметь вид yum install gdb, а на дебиане это apt install gdb)​

- Созданный дамп будет иметь название Core. (Внимание! Дамп может содержать ваш rcon и другие личные данные. Архивируйте его с паролем и давайте только проверенным людям)​

Заключение.

• Всегда оставайтесь вежливыми и учтивыми. Тогда к вам проникнутся симпатией и начнут помогать в ответ.
• Не нервничайте, если вам не отвечают сразу после создания темы. На решение проблемы нужно время и не всегда оно есть, проявляйте терпение. Неожиданно, но иногда другие люди бывают заняты своими делами.
• Придерживайтесь правила: 1 баг-репорт = 1 проблема.
• Если вам помогли за пределами созданной темы, то не забудьте вернуться в тему вашей проблемы и поделиться решением с остальными участниками форума.
• Указание конкретики без воды в тексте - наилучший путь к кратчайшему решению проблемы.

---

В данной статье использовались материалы форума AGHL.ru и руководство "Как правильно задавать вопросы"
Размещение статьи на сторонние ресурсы допускается только с сохранением активной ссылки на dev-cs.ru​