Уже который год мне среди issue и тикетов встречаются такие, из прочтения которых вообще не ясно, в чём, собственно, проблема. Чтобы вас поняли нужно соблюсти следующие пункты:
- Что вы делаете? Важно описать точный набор шагов, следуя которым можно воспроизвести проблему. Стоит помнить, что вашего проекта у разбирающего issue нет.
- Что получаете?
- Чего ожидаете?
- Почему это проблема? Важный пункт. Описываем, почему мы ожидаем того что ожидаем и на что это влияет. Здесь важно показать не только что, допустим, из класса
BaseServiceвернётсяtrueвместоfalse, но и что это значит с точки зрения конечного пользователя. - Не предлагать решение. Для этого есть pull request или комментарии.
- Не пытаться описать более одной проблемы за раз.
