Создание отчетов об ошибках для Discourse на Meta

:bookmark: Это руководство по сообщению об ошибках, которые вы нашли в Discourse, с использованием правильных каналов.

:person_raising_hand: Требуемый уровень пользователя: Сообщать об ошибках может любой

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

Краткое содержание

В этом руководстве вы узнаете:

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

Убедитесь, что ошибка не исправлена

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

Проверка проблемы

Чтобы подтвердить, что ваша проблема является воспроизводимой ошибкой, а не специфична для вашей конфигурации:

  1. Протестируйте на try.discourse.org: Используйте стандартный песочницу на try.discourse.org, чтобы проверить, можно ли воспроизвести проблему.
  2. Используйте ветку latest: Если вы тестируете на собственном экземпляре Discourse, убедитесь, что используете ветку latest

Дополнительные шаги (необязательно)

  • Отправьте Pull Request: Если вы способны, отправьте pull request с failing test, демонстрирующим ошибку.
  • Исправьте ошибку самостоятельно: Если вы предпочитаете решить проблему самостоятельно, следуйте Contributing to Discourse development.

Создание подробного отчёта об ошибке

Наконец, если проблема сохраняется и вы подтвердили её в тестовом окружении:

  1. Создайте тему в категории ошибок: Перейдите в категорию ошибок на Meta и создайте новую тему.
  2. Включите воспроизводимые шаги: Подробно опишите всё, что вы знаете об ошибке, включая шаги для её воспроизведения. Обратитесь к руководству по написанию хорошего отчёта об ошибке для получения советов о том, какую информацию следует включить.

После исправления ошибки вы обычно можете ожидать обновления в теме отчёта.


Дополнительные ресурсы

18 лайков