Доклады по программным ошибкам и проблемам
From Joomla! Documentation
Чтобы сообщить о какой-либо программной ошибке на тракер программных ошибок Joomla!, Вам необходимо создать некоторый тракерный пункт. Как только этот тракерный пункт создан, определенный разработчик проверит его действительность и отреагирует соответствующим образом. Если Вы желаете помочь в тестировании патчей системы Joomla!, то выполните, пожалуйста, эти подробные инструкции.
Сообщить о программных ошибках
Зарегистрируйте аккаунт на GitHub
Вам будет необходимо зарегистрировать свой аккаунт на GitHub; тракер "Joomla! Issue Tracker" использует для входа аккаунты на GitHub.
Войдите в тракер багов Joomla!
- Joomla! Issue Tracker- Открытые
Проверьте, была ли эта программная ошибка, о которой Вы собираетесь доложить, уже отправлена ранее на тракер.
Элементы трекера отображаются с помощью ряда фильтров, доступ к которым можно получить, нажав кнопку «Инструменты поиска» в верхней части списка. Если о проблеме, с которой вы столкнулись, еще не сообщалось, нажмите кнопку «Новый элемент» в основной области навигации.
Будет показан новый экран. Чем больше информации Вы представите, тем легче будет [работать] разработчикам [над ее устранением].
Предоставьте как можно больше информации. Щелкая на переключатель "Режим просмотра" в правой части экрана с "Pro" на "Помощь" Для каждого поля Вы можете включить подсказки для каждого поля.
- Приоритет : Используйте [приоритет] по умолчанию "Средний", за исключением [случаев], где Вы достаточно хорошо знакомы с кодом, чтобы [оправдать] выбор другого [приоритета].
- Билд: введите здесь версию(ии), [на которую(ые)] распространяется данная проблема.
- Категории: здесь более сложно. Используйте "Administration", если Вы не можете предложить лучший [выбор].
- Название: краткое изложение данной проблемы.
- Описание: подробно о данной ошибке. Для подробных указаний познакомтесь, пожалуйста, с ниже расположенным разделом.
- Загрузка: пользователям разрешается вместе с докладами об ошибках загружать изображения. Информация по требованиям к загрузке приведена на веб-форме доклада.
Предоставьте краткое изложение этой программной ошибки
Опишите в нескольких словах обнаруженную Вами проблему. Если это Ваш первый доклад на тракер о [найденной] програмной ошибке, то в общем будет неплохой идеей воспользоваться уже существующими на тракере записями в качестве примера.
Примеры:
- Лицевая часть: такое-то и такое-то предупреждение.
- Административная часть: после публикации плагина "названиеплагина" не удается сохранить материалы.
Примечание: уделите [должное] внимание [созданию] своего краткого изложения [обнаруженной програмной ошибки], поскольку она будет первым, что увидят разработчики, гоняющиеся на тракере за отладкой ошибок.
Предоставьте подробную информацию о данной программной ошибке
Чтобы получить наиболее полную информацию, тракер заполняет поле описания шаблоном с пятью под-разделами:
- Шаги для воспроизведения этой проблемы: подробные пошаговые [указания] о [том], как другой человек сможет воспроизвести эту ошибку.
- Ожидаемый результат: что по-Вашему должно произойти, как только будут выполнены выше указанные [пошаговые] инструкции.
- Фактический результат: что фактически произошло как только были выполнены выше указанные пошаговые [указания].
- Информация по системе: информация по конфигурации Вашей системной среды. Сюда входит какой браузер Вы используете, версия PHP Вашего сервера или тип используемой на Вашем веб-сайте базы данных. Для наиболее оптимального результата Вы можете скопировать данные, войдя в административный раздел [по навигационному пути] "Система" -> "Информация о системе".
- Дополнительные комментарии: любая не предоставленная выше информация, которая может быть полезна для поиска этой неисправности и ее устранения.
Общий формат должен быть примерно таким:
- "Вот в точности что я проделал."
- "Вот что произошло."
- "Вот что по-моему должно было произойти."
- "Другая информация, возможное решение, предложенный патч [с] кодом."
Чем больше информации, тем лучше. Также важно воспроизвести данную ошибку, используя веб-сайт [с] демонстрационными данными Joomla или с простыми и четкими инструкциями относительно того, как [прийти] к ней. Помните, что у других не будет доступа к базе данных Вашего веб-сайта, так что Вам будет нужно подсказать другим как [можно] увидеть данный баг [с помощью имеющихся в их распоряжении] данных, т.е. демонстрационного веб-сайта.
Пример А
- Что я сделал
- начал на демонстрационном веб-сайте. Все было в порядке. Я включил [плагин] "названиеплагина". Попытайтесь сохранить какой-либо материал в административной панели.
- Что произошло
- я получил былый экран и материал не был сохранен.
- Что должно было произойти
- материалы должны сохраняться правильно.
- Прочие данные
- это какие плагины включены одновременно. SEF включен (или выключен). Мой веб-сайт находится в такой-то под-директории. Я также отмечаю, что .... По-моему, такой-то и такой-то файл являются [источником] проблемы (если Вы знаете о чем Вы говорите).
Пример Б
- Что я сделал
- прошел в административную панель. Щелкнул на пункт меню "название_пункта_меню".
- Что получилось
- страница открылась как белый экран.
- Что должно было получиться
- меню должно было открыть [страницу] правильно.
- Дополнительная информация
- любые другие меню работают в порядке.
Примеры из практики
- Что я сделал
- Начал на веб-сайте с демонстрационными [данными].
- Добавил [находясь в] административной панели неопубликованный материал в категории FAQ, под-категории "General".
- Во вкладке расширенных параметров отображения материала установите "Заголовок" на "Скрыть" и "Иконка печати" и "Иконка электронной почты" на "Скрыть".
- Сохраните этот материал и пройдите на лицевую часть [веб-сайта]. Войдите в лицевую часть как администрато и пройдите на пункт меню "Example Pages" -> "Category Blog".
- Что произошло: только что созданный материал показан на [его] лицевой части [веб-сайта] , но [на его веб-странице] нет иконки "Изменить" [для редактирования этого материла с лицевой части].
- Что должно было произойти: иконка "Изменить" должна была показаться, позволяя пользователю лицевой части [щелкнуть на нее] чтобы отредактировать этот материал.
- Прочая информация: это происходит только с шаблоном "protostar". Изменяя следующий код [предлагаемый код] в файле [название и путь к данному файлу], строка(и) номер ..., данная проблема в моих настройках исчезла.
Создать "pull" запрос непосредственно в Joomla-вском репозитории на GitHub
Если Вы желаете предложить какое-либо исправление, предоставляя код для самой системы Joomla, то Вы можете сделать это создав запрос "pull" в репозитории кода Joomla на GitHub.com, расположенного здесь: https://github.com/joomla/joomla-cms
Этот процесс требует некоторого опыта в отношении систем управления исходным кодом, конкретно - системы Git. Если Вы знаете что такое 'Git SCM' и как она работает, то этот процесс [будет для Вас] прост.:
- Зарегистрируйтесь на бесплатный аккаунта на GitHub.com.
- Ответвите репозиторий Joomla
- Переключитесь на ветку «staging», если вы хотите предложить исправление для текущего релиза Joomla! 3.x, или на другую ветку, если вы хотите предложить исправление для следующей версии Joomla!
- Добавьте/обновите соответствующие файлы системы Joomla в правой ветке и затем щелкните на кнопку "review & compare" ("просмотреть и сравнить") - больше об этом на https://help.github.com/articles/using-pull-requests (англ) - начать процесс создания запроса на "pull".
Дополнительные подсказки и трюки
Хорошо написанные доклады об ошибках [являются] существенной помощью. Однако, с работой любой системы тракинга программных ошибок связаны расходы ресурсов, так что Ваша помощь в [том, чтобы] содержать наш трекет как можно [более] полезным, [будет принята с] признательностью. Особенно:
- Обязательно прочитайте раздел FAQ чтобы проверить, не является ли Ваша проблема [уже] хорошо известным вопросом.
- Проведите поиск на тракере чтобы проверить, не была ли Ваша проблема уже отправлена на него.
- Если Вы не уверены в том, является ли то, что Вы обнаружили, программной ошибкой, то обязательно задайте вопрос о том как отправлять доклады о программных ошибках на форуме Joomla 3.x f.
- Обязательно пишите полные, конкретные и с четкими указаниями [по воспроизведению данной ошибки] доклады. Включайте как можно больше информации, дополняя ее отрывками кода, пользовательскими сценариями и так далее. Самый лучший доклад о программной ошибке - это минимальный пример, который иллюстрирует конкретную программную ошибку в небольшом пользовательском сценарии.
- Не используйте систему трекеров, чтобы задавать вопросы в службу поддержки. Используйте для этого форумы Joomla!.
- Не используйте трекеры для масштабных запросов о возможностях. Мы предпочитаем обсуждать любые крупные изменения в ядре Joomla! на форумах для разработчиков, прежде чем приступать к работе над ними.
- Не открывайте заново проблемы, которые были помечены как «решение в ожидании». Эта пометка означает, что принято решение о том, что мы не можем или не будем исправлять эту конкретную проблему. Если вы не знаете, почему, спросите об этом на форумедля разработчиков.
Не используйте тракер для длинных обсуждений, потому что они наиболее вероятно потеряются. Если какой-либо пункт тракера вызывает споры, переместите его, пожалуйста, на форум разработчика.
Доклад проблем с безопасностью
Докладывайте о проблемах с безопасностью по [адресу электронной почты] security [at] joomla [dot] org. Этот приватный почтовый список открыт только давно работающим и доверенным разработчикам [системы] Joomla! и его архивы закрыты от публичного чтения.
В случае какой-либо подтвержденной уязвимости самой [системы] Joomla, мы примем следующие меры:
- Подтвердим доложившему получение данного доклада и будущее исправление. Мы предоставим приблизительный срок времени и попросим доложившего сохранять данную проблему конфиденциально до тех пор, пока мы не объявим о ней.
- Остановим другие разработки на столько [времени], сколько нужно для разработки какого-либо исправления, включая патчи для текущего и двух предыдущих выпусков.
- Определим дату публичного объявления о данной уязвимости и ее устранении. В целях сведения к минимуму возможную "гонку вооружений" между теми, кто применяет данный патч и теми, кто пытается злоупотреблять данной уязвимостью, мы не будем объявлять о проблемах с безопасностью немедленно.
- Публично объявим о данной уязвимости и [ее] устранении согласно предварительно назначенной [для этого] даты. Наиболее вероятно это будет означать новый выпуск [системы] Joomla, но в некоторых случаях это возможно будет просто патч для текущего выпуска.